1 /**
2 * This file Copyright (c) 2003-2013 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.cms.gui.dialog;
35
36 import info.magnolia.cms.core.Content;
37
38 import java.io.IOException;
39 import java.io.Writer;
40
41 import javax.jcr.RepositoryException;
42 import javax.servlet.http.HttpServletRequest;
43 import javax.servlet.http.HttpServletResponse;
44
45
46 /**
47 * Interface for dialogs. A Magnolia Dialog should at least implements the <code>drawHtml</code> method to add html
48 * code to a page. Dialogs must have an empty constructor; the <code>init(Content, Content, PageContext)</code> is
49 * assured to be called before any other operation.
50 * @author Vinzenz Wyser
51 * @version 2.0
52 */
53 public interface DialogControl {
54
55 /**
56 * Initialize a Dialog. This method is guaranteed to be called just after the control instantiation.
57 * @param request current HttpServletRequest
58 * @param response current HttpServletResponse
59 * @param websiteNode current website node
60 * @param configNode configuration node for the dialog
61 * @throws RepositoryException
62 */
63 void init(HttpServletRequest request, HttpServletResponse response, Content websiteNode, Content configNode)
64 throws RepositoryException;
65
66 /**
67 * Actually draw the dialog content.
68 * @param out Writer
69 * @throws IOException exceptions thrown when writing to the Writer can be safely rethrown by the dialog
70 */
71 void drawHtml(Writer out) throws IOException;
72
73 }