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.ui.components;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResourceFilter;
032import org.opencms.ui.CmsVaadinUtils;
033import org.opencms.ui.apps.Messages;
034import org.opencms.ui.components.fileselect.CmsPathSelectField;
035
036/**
037 * Folder selector component.
038 */
039public class CmsFolderSelector extends CmsPathSelectField {
040
041    /** Serial version id. */
042    private static final long serialVersionUID = 1L;
043
044    /**
045     * Creates a new folder selector.
046     */
047    public CmsFolderSelector() {
048
049        setCaption(CmsVaadinUtils.getMessageText(Messages.GUI_SOURCESEARCH_RESOURCE_PATH_0));
050        setDescription(CmsVaadinUtils.getMessageText(Messages.GUI_SOURCESEARCH_RESOURCE_PATH_HELP_0));
051        disableSiteSwitch();
052        setResourceFilter(CmsResourceFilter.DEFAULT_FOLDERS);
053        requireFolder();
054        setValue("/");
055        setWidth("100%");
056    }
057
058    /**
059     * Returns the CMS object of this folder selector.
060     * @return the CMS object of this folder selector
061     */
062    public CmsObject getCmsObject() {
063
064        return m_cms;
065    }
066}