1 /**
2 * This file Copyright (c) 2012-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.dialog.formdialog;
35
36 import info.magnolia.ui.api.context.UiContext;
37 import info.magnolia.ui.dialog.DialogPresenter;
38 import info.magnolia.ui.dialog.DialogView;
39 import info.magnolia.ui.dialog.definition.FormDialogDefinition;
40 import info.magnolia.ui.form.EditorCallback;
41 import info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector;
42
43 import com.vaadin.v7.data.Item;
44
45 /**
46 * Interface for {@link FormDialogPresenterImpl}.
47 */
48 public interface FormDialogPresenter extends DialogPresenter {
49
50 @Override
51 FormView getView();
52
53 /**
54 * Starts (builds and renders) a form dialog component.
55 *
56 *
57 *
58 * @param item
59 * @param dialogDefinition definition of the dialog.
60 * @param uiContext current UI context (normally this is sub-app context).
61 * @param callback callback fired when the form dialog finishes its work.
62 * @return resulting {@link DialogView}.
63 */
64 DialogView start(Item item, FormDialogDefinition dialogDefinition, UiContext uiContext, EditorCallback callback);
65
66 /**
67 * Starts (builds and renders) a form dialog component.
68 *
69 *
70 *
71 * @param item
72 * @param dialogId id of the dialog.
73 * @param uiContext current UI context (normally this is sub-app context).
74 * @param callback callback fired when the form dialog finishes its work.
75 * @return resulting {@link DialogView}.
76 */
77 DialogView start(Item item, String dialogId, UiContext uiContext, EditorCallback callback);
78
79 /**
80 * Starts (builds and renders) a form dialog component. {@link ContentConnector} parameter allows
81 * for specifying concrete connector to be used within the dialog.
82 *
83 *
84 * @param item id of a Vaadin item used as a dialogs data-source.
85 * @param dialogDefinition definition of the dialog.
86 * @param uiContext current UI context (normally this is sub-app context).
87 * @param callback callback fired when the form dialog finishes its work.
88 * @param contentConnector specific content connector to be used in the dialog.
89 * @return resulting {@link DialogView}.
90 */
91 DialogView start(Item item, FormDialogDefinition dialogDefinition, UiContext uiContext, EditorCallback callback, ContentConnector contentConnector);
92
93 default Item getRelatedItem() {
94 return null;
95 }
96 }