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.searchindex;
029
030import org.opencms.jsp.CmsJspActionElement;
031import org.opencms.widgets.CmsDisplayWidget;
032import org.opencms.workplace.CmsWidgetDialogParameter;
033
034import javax.servlet.http.HttpServletRequest;
035import javax.servlet.http.HttpServletResponse;
036import javax.servlet.jsp.PageContext;
037
038/**
039 *
040 * Widget dialog for an overview of a <code>{@link CmsOverviewIndexSourceDialog}</code>.<p>
041 *
042 * @since 6.0.0
043 */
044public class CmsOverviewIndexSourceDialog extends A_CmsEditIndexSourceDialog {
045
046    /**
047     * Public constructor with JSP action element.<p>
048     *
049     * @param jsp an initialized JSP action element
050     */
051    public CmsOverviewIndexSourceDialog(CmsJspActionElement jsp) {
052
053        super(jsp);
054    }
055
056    /**
057     * Public constructor with JSP variables.<p>
058     *
059     * @param context the JSP page context
060     * @param req the JSP request
061     * @param res the JSP response
062     */
063    public CmsOverviewIndexSourceDialog(PageContext context, HttpServletRequest req, HttpServletResponse res) {
064
065        this(new CmsJspActionElement(context, req, res));
066    }
067
068    /**
069     * Creates the dialog HTML for all defined widgets of the named dialog (page).<p>
070     *
071     * This overwrites the method from the super class to create a layout variation for the widgets.<p>
072     *
073     * @param dialog the dialog (page) to get the HTML for
074     * @return the dialog HTML for all defined widgets of the named dialog (page)
075     */
076    @Override
077    protected String createDialogHtml(String dialog) {
078
079        StringBuffer result = new StringBuffer(1024);
080
081        result.append(createWidgetTableStart());
082        // show error header once if there were validation errors
083        result.append(createWidgetErrorHeader());
084
085        if (dialog.equals(PAGES[0])) {
086            // create the widgets for the first dialog page
087            result.append(dialogBlockStart(key(Messages.GUI_LABEL_INDEXSOURCE_BLOCK_SETTINGS_0)));
088            result.append(createWidgetTableStart());
089            result.append(createDialogRowsHtml(0, 1));
090            result.append(createWidgetTableEnd());
091            result.append(dialogBlockEnd());
092        }
093
094        result.append(createWidgetTableEnd());
095
096        // Output the list with cocument types:
097        return result.toString();
098    }
099
100    /**
101     * @see org.opencms.workplace.CmsWidgetDialog#defaultActionHtmlEnd()
102     */
103    @Override
104    protected String defaultActionHtmlEnd() {
105
106        return "";
107    }
108
109    /**
110     * Creates the list of widgets for this dialog.<p>
111     */
112    @Override
113    protected void defineWidgets() {
114
115        super.defineWidgets();
116        addWidget(new CmsWidgetDialogParameter(m_indexsource, "name", PAGES[0], new CmsDisplayWidget()));
117        addWidget(new CmsWidgetDialogParameter(m_indexsource, "indexerClassName", PAGES[0], new CmsDisplayWidget()));
118    }
119
120}