View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.action;
35  
36  import info.magnolia.i18nsystem.I18nizer;
37  import info.magnolia.ui.UIComponent;
38  import info.magnolia.ui.ValueContext;
39  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
40  import info.magnolia.ui.dialog.DialogDefinition;
41  import info.magnolia.ui.dialog.DialogDefinitionRegistry;
42  import info.magnolia.ui.dialog.actions.OpenDialogAction;
43  import info.magnolia.ui.dialog.actions.OpenDialogActionDefinition;
44  import info.magnolia.ui.editor.LocaleContext;
45  import info.magnolia.ui.form.definition.DefinitionConverter;
46  
47  import java.util.Optional;
48  
49  import javax.inject.Inject;
50  
51  /**
52   * Compatibility open dialog action class convert old dialog definition to new one.
53   *
54   * @deprecated since 6.2 - used as a compatibility measure to open pre-6.2 dialogs
55   * in updated UI component implementations.
56   *
57   * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
58   */
59  @Deprecated
60  public class CompatibilityOpenDialogAction extends OpenDialogAction {
61  
62      @Inject
63      public CompatibilityOpenDialogAction(OpenDialogActionDefinition definition, LocaleContext localeContext, ValueContext valueContext, UIComponent parentView, I18NAuthoringSupport i18NAuthoringSupport, DialogDefinitionRegistry dialogDefinitionRegistry, I18nizer i18nizer) {
64          super(definition, localeContext, valueContext, parentView, i18NAuthoringSupport, dialogDefinitionRegistry, i18nizer);
65      }
66  
67      @Override
68      protected DialogDefinition getDialogDefinition(DialogDefinitionRegistry dialogDefinitionRegistry, I18nizer i18nizer) {
69  
70          Optional<DialogDefinition> dialogDefinition = Optional.of(super.getDialogDefinition(dialogDefinitionRegistry, i18nizer));
71  
72          return dialogDefinition
73                  .filter(info.magnolia.ui.dialog.definition.FormDialogDefinition.class::isInstance)
74                  .map(info.magnolia.ui.dialog.definition.FormDialogDefinition.class::cast)
75                  .map(DefinitionConverter.DIALOG::convert)
76                  .orElse(dialogDefinition.orElse(null));
77      }
78  }