View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.definition;
35  
36  import info.magnolia.ui.api.action.ActionDefinition;
37  import info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel;
38  import info.magnolia.ui.dialog.DialogPresenter;
39  import info.magnolia.ui.dialog.actionarea.definition.ConfiguredEditorActionAreaDefinition;
40  import info.magnolia.ui.dialog.actionarea.definition.EditorActionAreaDefinition;
41  
42  import java.util.LinkedHashMap;
43  import java.util.Map;
44  
45  /**
46   * Implementation of {@link DialogDefinition}.
47   *
48   * @deprecated since 6.0. Use new framework and {@link info.magnolia.ui.dialog.ConfiguredDialogDefinition} instead.
49   */
50  @Deprecated
51  public class ConfiguredDialogDefinition implements DialogDefinition {
52  
53      public static final String ACTIONS_NODE_NAME = "actions";
54      public static final String EXTEND_PROPERTY_NAME = "extends";
55  
56      private String id;
57  
58      private String label;
59  
60      private String i18nBasename;
61  
62      private boolean isWide = false;
63  
64      private Map<String, ActionDefinition> actions = new LinkedHashMap<String, ActionDefinition>();
65  
66      private Class<? extends DialogPresenter> presenterClass;
67  
68      private EditorActionAreaDefinition actionArea = new ConfiguredEditorActionAreaDefinition();
69  
70      private ModalityLevel modalityLevel = ModalityLevel.STRONG;
71  
72      @Override
73      public String getId() {
74          return id;
75      }
76  
77      public void setId(String id) {
78          this.id = id;
79      }
80  
81      @Override
82      public String getLabel() {
83          return label;
84      }
85  
86      public void setLabel(String label) {
87          this.label = label;
88      }
89  
90      @Override
91      public String getI18nBasename() {
92          return i18nBasename;
93      }
94  
95      public void setI18nBasename(String i18nBasename) {
96          this.i18nBasename = i18nBasename;
97      }
98  
99      @Override
100     public Map<String, ActionDefinition> getActions() {
101         return actions;
102     }
103 
104     @Override
105     public Class<? extends DialogPresenter> getPresenterClass() {
106         return presenterClass;
107     }
108 
109     public void setActions(Map<String, ActionDefinition> actions) {
110         this.actions = actions;
111     }
112 
113     public void addAction(ActionDefinition actionDefinition) {
114         actions.put(actionDefinition.getName(), actionDefinition);
115     }
116 
117     public void setPresenterClass(Class<? extends DialogPresenter> presenterClass) {
118         this.presenterClass = presenterClass;
119     }
120 
121     @Override
122     public EditorActionAreaDefinition getActionArea() {
123         return actionArea;
124     }
125 
126     public void setActionArea(EditorActionAreaDefinition actionArea) {
127         this.actionArea = actionArea;
128     }
129 
130     /**
131      * @return the currently set {@link ModalityLevel}. If not set, it is {@link ModalityLevel#STRONG} by default.
132      */
133     @Override
134     public ModalityLevel getModalityLevel() {
135         return this.modalityLevel;
136     }
137 
138     public void setModalityLevel(ModalityLevel modalityLevel) {
139         this.modalityLevel = modalityLevel;
140     }
141 
142     /**
143      * @return Whether the dialog should be displayed in a wide mode by default.
144      */
145     @Override
146     public boolean isWide() {
147         return isWide;
148     }
149 
150     public void setWide(boolean isWide){
151         this.isWide = isWide;
152     }
153 }