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;
031import org.opencms.jsp.CmsJspActionElement;
032import org.opencms.main.CmsException;
033
034/**
035 * Provides a method for selecting an individual file editor.<p>
036 *
037 * You can define the class of your own editor handler in the OpenCms XML configuration files.
038 * changing the &lt;class&gt; subnode of the system node &lt;editorhandler&gt; to another value.
039 * The class you enter must implement this interface to obtain the URI of the displayed editor.<p>
040 *
041 * @since 6.0.0
042 */
043public interface I_CmsEditorHandler {
044
045    /**
046     * Returns the editor URI which will be used for the selected resource type.<p>
047     *
048     * @param cms the cms context
049     * @param resourceType the resource type name
050     * @param userAgent the user agent header
051     * @param loadDefault <code>true</code> to force the default editor
052     *
053     * @return the absolute path to the editor
054     */
055    String getEditorUri(CmsObject cms, String resourceType, String userAgent, boolean loadDefault);
056
057    /**
058     * Returns the editor URI which will be used for the selected resource in the OpenCms VFS to the editor selector class.<p>
059     *
060     * @param resource the selected resource
061     * @param jsp the CmsJspActionElement
062     *
063     * @return the absolute path to the editor that will be displayed or <code>null</code> if resource is not editable
064     *
065     * @throws CmsException if something goes wrong
066     */
067    String getEditorUri(String resource, CmsJspActionElement jsp) throws CmsException;
068
069}