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.search.CmsVfsIndexer;
032import org.opencms.widgets.CmsComboWidget;
033import org.opencms.widgets.CmsDisplayWidget;
034import org.opencms.widgets.CmsInputWidget;
035import org.opencms.widgets.CmsSelectWidgetOption;
036import org.opencms.workplace.CmsWidgetDialogParameter;
037
038import java.util.ArrayList;
039import java.util.List;
040
041import javax.servlet.http.HttpServletRequest;
042import javax.servlet.http.HttpServletResponse;
043import javax.servlet.jsp.PageContext;
044
045/**
046 *
047 * Dialog to edit new or existing search indexsource in the administration view.<p>
048 *
049 * @since 6.0.0
050 */
051public class CmsEditIndexSourceDialog extends A_CmsEditIndexSourceDialog {
052
053    /**
054     * Public constructor with JSP action element.<p>
055     *
056     * @param jsp an initialized JSP action element
057     */
058    public CmsEditIndexSourceDialog(CmsJspActionElement jsp) {
059
060        super(jsp);
061    }
062
063    /**
064     * Public constructor with JSP variables.<p>
065     *
066     * @param context the JSP page context
067     * @param req the JSP request
068     * @param res the JSP response
069     */
070    public CmsEditIndexSourceDialog(PageContext context, HttpServletRequest req, HttpServletResponse res) {
071
072        this(new CmsJspActionElement(context, req, res));
073    }
074
075    /**
076     * Creates the dialog HTML for all defined widgets of the named dialog (page).<p>
077     *
078     * This overwrites the method from the super class to create a layout variation for the widgets.<p>
079     *
080     * @param dialog the dialog (page) to get the HTML for
081     * @return the dialog HTML for all defined widgets of the named dialog (page)
082     */
083    @Override
084    protected String createDialogHtml(String dialog) {
085
086        StringBuffer result = new StringBuffer(1024);
087
088        result.append(createWidgetTableStart());
089        // show error header once if there were validation errors
090        result.append(createWidgetErrorHeader());
091
092        if (dialog.equals(PAGES[0])) {
093            // create the widgets for the first dialog page
094            result.append(dialogBlockStart(key(Messages.GUI_LABEL_INDEXSOURCE_BLOCK_SETTINGS_0)));
095            result.append(createWidgetTableStart());
096            result.append(createDialogRowsHtml(0, 1));
097            result.append(createWidgetTableEnd());
098            result.append(dialogBlockEnd());
099        }
100
101        result.append(createWidgetTableEnd());
102        return result.toString();
103    }
104
105    /**
106     * Creates the list of widgets for this dialog.<p>
107     */
108    @Override
109    protected void defineWidgets() {
110
111        super.defineWidgets();
112
113        // widgets to display
114        // new indexsource
115        if (m_indexsource.getName() == null) {
116            addWidget(new CmsWidgetDialogParameter(m_indexsource, "name", PAGES[0], new CmsInputWidget()));
117        } else {
118            // existing indexsource
119            addWidget(new CmsWidgetDialogParameter(m_indexsource, "name", PAGES[0], new CmsDisplayWidget()));
120        }
121        addWidget(
122            new CmsWidgetDialogParameter(
123                m_indexsource,
124                "indexerClassName",
125                "",
126                PAGES[0],
127                new CmsComboWidget(getIndexerClassWidgetConfiguration()),
128                1,
129                1));
130
131    }
132
133    /**
134     * Returns the indexer class widget configuration.<p>
135     *
136     * @return the indexer class widget configuration
137     */
138    private List<CmsSelectWidgetOption> getIndexerClassWidgetConfiguration() {
139
140        List<CmsSelectWidgetOption> result = new ArrayList<CmsSelectWidgetOption>();
141        result.add(new CmsSelectWidgetOption(CmsVfsIndexer.class.getName(), true));
142        return result;
143    }
144}