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 org.opencms.search.fields.CmsLuceneField}</code>.<p>
041 *
042 * @since 6.5.5
043 */
044public class CmsOverviewFieldDialog extends A_CmsFieldDialog {
045
046    /**
047     * Public constructor with JSP action element.<p>
048     *
049     * @param jsp the jsp action element
050     */
051    public CmsOverviewFieldDialog(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 CmsOverviewFieldDialog(PageContext context, HttpServletRequest req, HttpServletResponse res) {
064
065        super(context, req, res);
066    }
067
068    /**
069     * Returns the String value of the indexed value.<p>
070     *
071     * @return String value of the indexed value
072     */
073    public String getIndexed() {
074
075        if ((m_field != null) && (m_field.getIndexed() != null)) {
076            return m_field.getIndexed();
077        }
078        return "";
079    }
080
081    /**
082     * Sets the indexed value of the field.<p>
083     *
084     * @param indexed String value of the indexed value
085     */
086    public void setIndexed(String indexed) {
087
088        m_field.setIndexed(indexed);
089    }
090
091    /**
092     * Creates the dialog HTML for all defined widgets of the named dialog (page).<p>
093     *
094     * This overwrites the method from the super class to create a layout variation for the widgets.<p>
095     *
096     * @param dialog the dialog (page) to get the HTML for
097     * @return the dialog HTML for all defined widgets of the named dialog (page)
098     */
099    @Override
100    protected String createDialogHtml(String dialog) {
101
102        StringBuffer result = new StringBuffer(1024);
103
104        result.append(createWidgetTableStart());
105        // show error header once if there were validation errors
106        result.append(createWidgetErrorHeader());
107
108        if (dialog.equals(PAGES[0])) {
109            // create the widgets for the first dialog page
110            result.append(dialogBlockStart(key(Messages.GUI_LABEL_FIELD_BLOCK_SETTINGS_0)));
111            result.append(createWidgetTableStart());
112            result.append(createDialogRowsHtml(0, 6));
113            result.append(createWidgetTableEnd());
114            result.append(dialogBlockEnd());
115        }
116
117        result.append(createWidgetTableEnd());
118        return result.toString();
119    }
120
121    /**
122     * @see org.opencms.workplace.CmsWidgetDialog#defaultActionHtmlEnd()
123     */
124    @Override
125    protected String defaultActionHtmlEnd() {
126
127        return "";
128    }
129
130    /**
131     * Creates the list of widgets for this dialog.<p>
132     */
133    @Override
134    protected void defineWidgets() {
135
136        super.defineWidgets();
137
138        addWidget(new CmsWidgetDialogParameter(m_field, "name", PAGES[0], new CmsDisplayWidget()));
139        addWidget(new CmsWidgetDialogParameter(m_field, "displayName", PAGES[0], new CmsDisplayWidget()));
140        addWidget(new CmsWidgetDialogParameter(m_field, "stored", PAGES[0], new CmsDisplayWidget()));
141        addWidget(new CmsWidgetDialogParameter(this, "indexed", PAGES[0], new CmsDisplayWidget()));
142        addWidget(new CmsWidgetDialogParameter(m_field, "inExcerpt", PAGES[0], new CmsDisplayWidget()));
143        addWidget(new CmsWidgetDialogParameter(m_field, "boost", PAGES[0], new CmsDisplayWidget()));
144        addWidget(new CmsWidgetDialogParameter(m_field, "defaultValue", PAGES[0], new CmsDisplayWidget()));
145    }
146}