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, 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.widgets;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.i18n.CmsMessages;
033import org.opencms.xml.types.A_CmsXmlContentValue;
034
035import java.util.Locale;
036
037/**
038 * Server-side part of the dependent select box widget.<p>
039 * Select widget which uses other values from the content as select options.<p>
040 *
041 * This works as follows: The widget is given a configuration consisting of three pipe-separated OpenCms content value paths.
042 * The first path is used to select a set of nested content values. The second and third paths are relative to the first path
043 * and are used to select a select option and a select option display text from the nested contents matching the first path.
044 * Note that if you omit indexes on a component of the first path, all indexes will be matched.
045 *
046 *
047 */
048public class CmsDependentSelectWidget extends CmsSelectWidget {
049
050    /**
051     * @see org.opencms.widgets.A_CmsSelectWidget#getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)
052     */
053    @Override
054    public String getConfiguration(
055        CmsObject cms,
056        A_CmsXmlContentValue schemaType,
057        CmsMessages messages,
058        CmsResource resource,
059        Locale contentLocale) {
060
061        return getConfiguration();
062    }
063
064    /**
065     * @see org.opencms.widgets.CmsSelectWidget#getWidgetName()
066     */
067    @Override
068    public String getWidgetName() {
069
070        return CmsDependentSelectWidget.class.getName();
071    }
072
073    /**
074     * @see org.opencms.widgets.CmsSelectWidget#newInstance()
075     */
076    @Override
077    public I_CmsWidget newInstance() {
078
079        return new CmsDependentSelectWidget();
080    }
081
082}