View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 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.module.blossom.dialog;
35  
36  import java.util.ArrayList;
37  import java.util.List;
38  import javax.servlet.http.HttpServletRequest;
39  import javax.servlet.http.HttpServletResponse;
40  
41  import info.magnolia.cms.core.Content;
42  import info.magnolia.cms.gui.dialog.Dialog;
43  import info.magnolia.cms.gui.dialog.DialogTab;
44  import info.magnolia.module.admininterface.SaveHandler;
45  
46  /**
47   * Holds the parameters required during dialog creation and validation.
48   *
49   * @since 0.5
50   */
51  public class DialogCreationContext {
52  
53      private HttpServletRequest request;
54      private HttpServletResponse response;
55      private Content configNode;
56      private Content websiteNode;
57      private Dialog dialog;
58      private String websitePath;
59      private List<ValidationCallback> validators = new ArrayList<ValidationCallback>();
60      private SaveHandler saveHandler;
61  
62      public HttpServletRequest getRequest() {
63          return request;
64      }
65  
66      public void setRequest(HttpServletRequest request) {
67          this.request = request;
68      }
69  
70      public HttpServletResponse getResponse() {
71          return response;
72      }
73  
74      public void setResponse(HttpServletResponse response) {
75          this.response = response;
76      }
77  
78      public Content getConfigNode() {
79          return configNode;
80      }
81  
82      public void setConfigNode(Content configNode) {
83          this.configNode = configNode;
84      }
85  
86      public Content getWebsiteNode() {
87          return websiteNode;
88      }
89  
90      public void setWebsiteNode(Content websiteNode) {
91          this.websiteNode = websiteNode;
92      }
93  
94      public Dialog getDialog() {
95          return dialog;
96      }
97  
98      public void setDialog(Dialog dialog) {
99          this.dialog = dialog;
100     }
101 
102     public String getWebsitePath() {
103         return websitePath;
104     }
105 
106     public SaveHandler getSaveHandler() {
107         return saveHandler;
108     }
109 
110     public void setSaveHandler(SaveHandler saveHandler) {
111         this.saveHandler = saveHandler;
112     }
113 
114     public void setWebsitePath(String websitePath) {
115         this.websitePath = websitePath;
116     }
117 
118     public void addValidator(ValidationCallback validator) {
119         validators.add(validator);
120     }
121 
122     public List<ValidationCallback> getValidators() {
123         return validators;
124     }
125 
126     public DialogTab getTab(String label) {
127         for (Object sub : dialog.getSubs()) {
128             if (sub instanceof DialogTab) {
129                 DialogTab d = (DialogTab) sub;
130                 if (d.getLabel().equals(label)) {
131                     return d;
132                 }
133             }
134         }
135         return null;
136     }
137 
138     public void executeValidators() {
139         for (ValidationCallback validator : validators) {
140             validator.validate(dialog);
141         }
142     }
143 }