001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.workplace.tools.modules;
029
030import org.opencms.jsp.CmsJspActionElement;
031import org.opencms.widgets.CmsInputWidget;
032import org.opencms.workplace.CmsWidgetDialogParameter;
033
034import javax.servlet.http.HttpServletRequest;
035import javax.servlet.http.HttpServletResponse;
036import javax.servlet.jsp.PageContext;
037
038/**
039 * Edit class to edit module parameters.<p>
040 *
041 * @since 6.0.0
042 */
043public class CmsModulesEditParameters extends CmsModulesEditBase {
044
045    /**
046     * Public constructor with JSP action element.<p>
047     *
048     * @param jsp an initialized JSP action element
049     */
050    public CmsModulesEditParameters(CmsJspActionElement jsp) {
051
052        super(jsp);
053    }
054
055    /**
056     * Public constructor with JSP variables.<p>
057     *
058     * @param context the JSP page context
059     * @param req the JSP request
060     * @param res the JSP response
061     */
062    public CmsModulesEditParameters(PageContext context, HttpServletRequest req, HttpServletResponse res) {
063
064        this(new CmsJspActionElement(context, req, res));
065    }
066
067    /**
068     * Creates the dialog HTML for all defined widgets of the named dialog (page).<p>
069     *
070     * @param dialog the dialog (page) to get the HTML for
071     * @return the dialog HTML for all defined widgets of the named dialog (page)
072     */
073    @Override
074    protected String createDialogHtml(String dialog) {
075
076        StringBuffer result = new StringBuffer(1024);
077
078        // create table
079        result.append(createWidgetTableStart());
080
081        // show error header once if there were validation errors
082        result.append(createWidgetErrorHeader());
083
084        if (dialog.equals(PAGES[0])) {
085            result.append(dialogBlockStart(key("label.parameter")));
086            result.append(createWidgetTableStart());
087            result.append(createDialogRowsHtml(0, 0));
088            result.append(createWidgetTableEnd());
089            result.append(dialogBlockEnd());
090        }
091        // close table
092        result.append(createWidgetTableEnd());
093
094        return result.toString();
095    }
096
097    /**
098     * Creates the list of widgets for this dialog.<p>
099     */
100    @Override
101    protected void defineWidgets() {
102
103        super.defineWidgets();
104
105        addWidget(new CmsWidgetDialogParameter(m_module, "parameters", PAGES[0], new CmsInputWidget()));
106
107    }
108
109}