org.opencms.ui.components.fileselect.CmsPathSelectField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.ui.components.fileselect;

import org.opencms.file.CmsResource;
import org.opencms.main.OpenCms;
import org.opencms.site.CmsSite;
import org.opencms.ui.A_CmsUI;

/**
 * File path select field. This field will also allow paths that are not pointing to any VFS resource.
 */
public class CmsPathSelectField extends A_CmsFileSelectField {

    /** Serial version id. */
    private static final long serialVersionUID = 1L;

    /** Flag indicating if only root paths are used. */
    private boolean m_useRootPaths;

    /**
     * @see com.vaadin.ui.AbstractField#getType()
     */
    @Override
    public Class getType() {

        return String.class;
    }

    /**
     * Gets the value.

     *
     * @return the value
     */
    @Override
    public String getValue() {

        return m_textField.getValue();
    }

    /**
     * Returns if only root paths are used.

     *
     * @return true if only root paths are used
     */
    public boolean isUseRootPaths() {

        return m_useRootPaths;
    }

    /**
     * Sets the resource value.

     *
     * @param resource the resource
     */
    @Override
    public void setResourceValue(CmsResource resource) {

        CmsSite site = OpenCms.getSiteManager().getSiteForRootPath(resource.getRootPath());
        if (!m_useRootPaths && A_CmsUI.getCmsObject().getRequestContext().getSiteRoot().equals(site.getSiteRoot())) {
            m_textField.setValue(A_CmsUI.getCmsObject().getSitePath(resource));
        } else {
            m_textField.setValue(resource.getRootPath());
        }
    }

    /**
     * Sets if only root paths should be used.

     *
     * @param useRootPaths true to use root paths only
     */
    public void setUseRootPaths(boolean useRootPaths) {

        m_useRootPaths = useRootPaths;
    }

    /**
     * Sets the value.
     *
     * @param value the new value
     */
    @Override
    public void setValue(String value) {

        m_textField.setValue(value);
    }
}