1 /**
2 * This file Copyright (c) 2014-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.contentapp.choosedialog;
35
36 import info.magnolia.objectfactory.ComponentProvider;
37 import info.magnolia.ui.api.context.UiContext;
38 import info.magnolia.ui.dialog.definition.ChooseDialogDefinition;
39 import info.magnolia.ui.framework.ioc.SessionStore;
40 import info.magnolia.ui.framework.ioc.UiContextBoundComponentProvider;
41 import info.magnolia.ui.framework.ioc.UiContextReference;
42
43 import java.lang.annotation.Annotation;
44 import java.util.HashMap;
45 import java.util.Map;
46
47 import com.google.inject.Key;
48
49 /**
50 * The {@link ChooseDialogComponentProviderUtil} helps creating a {@link ComponentProvider} dedicated to a choose dialog.
51 */
52 public class ChooseDialogComponentProviderUtil {
53
54 /**
55 * Creates the choose-dialog specific component provider, with proper bindings for e.g.
56 * {@link info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector} and
57 * {@link info.magnolia.ui.imageprovider.ImageProvider}.
58 * <p>
59 * In particular, this ensures that within the dialog, these components get their dependencies as configured
60 * in the choose-dialog definition, rather than from current sub-app context.
61 *
62 * @param chooseDialogDefinition the choose-dialog definition, as configured for a content app, or built by code.
63 * @param componentProvider the parent {@link ComponentProvider}.
64 * @return a new component provider, to create {@link info.magnolia.ui.dialog.choosedialog.ChooseDialogPresenter ChooseDialogPresenter} with.
65 */
66 public static UiContextBoundComponentProvider createChooseDialogComponentProvider(ChooseDialogDefinition chooseDialogDefinition, ComponentProvider componentProvider) {
67 return createChooseDialogComponentProvider(componentProvider.getComponent(UiContext.class), chooseDialogDefinition, componentProvider);
68 }
69
70 /**
71 * Creates the choose-dialog specific component provider, with proper bindings for e.g.
72 * {@link info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector} and
73 * {@link info.magnolia.ui.imageprovider.ImageProvider}, and registers given {@link UiContext} for further use.
74 * <p>
75 * In particular, this ensures that within the dialog, these components get their dependencies as configured
76 * in the choose-dialog definition, rather than from current sub-app context.
77 *
78 * @param uiContext the choose-dialog's UiContext, so that dialog actions can use it.
79 * @param chooseDialogDefinition the choose-dialog definition, as configured for a content app, or built by code.
80 * @param componentProvider the parent {@link ComponentProvider}.
81 * @return a new component provider, to create {@link info.magnolia.ui.dialog.choosedialog.ChooseDialogPresenter ChooseDialogPresenter} with.
82 */
83 public static UiContextBoundComponentProvider createChooseDialogComponentProvider(UiContext uiContext, ChooseDialogDefinition chooseDialogDefinition, ComponentProvider componentProvider) {
84 final UiContextReference parentUiContextReference = ((UiContextBoundComponentProvider) componentProvider).getUiContextReference();
85 final UiContextReference chooseDialogKey = UiContextReference.ofView("choosedialog", parentUiContextReference);
86
87 final Map<Key, Object> instances = new HashMap<>();
88 final Annotation chooseDialogKeyAnnotation = chooseDialogKey.getAnnotation();
89
90 instances.put(Key.get(ChooseDialogDefinition.class, chooseDialogKeyAnnotation), chooseDialogDefinition);
91 instances.put(Key.get(UiContext.class, chooseDialogKeyAnnotation), uiContext);
92
93 SessionStore.access().createBeanStore(chooseDialogKey, instances);
94
95 return new UiContextBoundComponentProvider(chooseDialogKey);
96 }
97 }