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.configuration.preferences;
029
030import org.opencms.file.CmsObject;
031import org.opencms.xml.content.CmsXmlContentProperty;
032
033/**
034 * Preference for the start folder.<p>
035 */
036public class CmsStartFolderPreference extends CmsBuiltinPreference {
037
038    /**
039     * The nice name.<p>
040     */
041    private static final String NICE_NAME = "%(key."
042        + org.opencms.workplace.commons.Messages.GUI_PREF_STARTUP_FOLDER_0
043        + ")";
044
045    /**
046     * Creates a new instance.<p>
047     *
048     * @param name the preference name
049     */
050    public CmsStartFolderPreference(String name) {
051
052        super(name);
053        m_basic = true;
054    }
055
056    /**
057     * @see org.opencms.configuration.preferences.CmsBuiltinPreference#getPropertyDefinition(org.opencms.file.CmsObject)
058     */
059    @Override
060    public CmsXmlContentProperty getPropertyDefinition() {
061
062        CmsXmlContentProperty prop = new CmsXmlContentProperty(
063            getName(), //name
064            null, //type
065            null, //widget
066            null, //widgetconfig
067            null, //regex
068            null, //ruletype
069            null, //default
070            NICE_NAME, //nicename
071            null, //description
072            null, //error
073            null//preferfolder
074        );
075        return prop;
076    }
077
078    /**
079     * @see org.opencms.configuration.preferences.CmsBuiltinPreference#getPropertyDefinition(org.opencms.file.CmsObject)
080     */
081    @Override
082    public CmsXmlContentProperty getPropertyDefinition(CmsObject cms) {
083
084        CmsXmlContentProperty prop = new CmsXmlContentProperty(
085            getName(), //name
086            "string", //type
087            "gallery", //widget
088            "configuration:{\"tabconfig\":\"folders\", \"gallerymode\":\"widget\"}", //widgetconfig
089            null, //regex
090            null, //ruletype
091            null, //default
092            NICE_NAME, //nicename
093            null, //description
094            null, //error
095            null//preferfolder
096        );
097        return prop;
098    }
099
100}