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.editors;
029
030import org.opencms.file.CmsObject;
031
032/**
033 * Provides methods to determine the CSS style sheet URI for the editors based on the edited resource path.<p>
034 *
035 * The method {@link #matches(CmsObject, String)} can be used to check
036 * if the handler matches the currently edited resource.<p>
037 *
038 * @since 6.9.2
039 */
040public interface I_CmsEditorCssHandler {
041
042    /**
043     * Returns the absolute VFS path of the CSS style sheet to use.<p>
044     *
045     * @param cms the current OpenCms user context
046     * @param editedResourcePath the absolute VFS path of the currently edited resource
047     * @return the absolute VFS path of the CSS style sheet to use
048     */
049    String getUriStyleSheet(CmsObject cms, String editedResourcePath);
050
051    /**
052     * Checks if the handler can be used to determine the CSS style sheet based on the edited resource.<p>
053     *
054     * @param cms the current OpenCms user context
055     * @param editedResourcePath the absolute VFS path of the currently edited resource
056     * @return  true if the handler matches, otherwise false
057     */
058    boolean matches(CmsObject cms, String editedResourcePath);
059
060}