content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://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 GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://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.workplace.editors;
  
  import org.opencms.file.CmsObject;
  import org.opencms.jsp.CmsJspActionElement;
  import org.opencms.main.CmsException;
  
  /**
   * Provides a method for selecting an individual file editor.<p>
   *
   * You can define the class of your own editor handler in the OpenCms XML configuration files.
   * changing the &lt;class&gt; subnode of the system node &lt;editorhandler&gt; to another value.
   * The class you enter must implement this interface to obtain the URI of the displayed editor.<p>
   *
   * @since 6.0.0
   */
  public interface I_CmsEditorHandler {
  
      /**
       * Returns the editor URI which will be used for the selected resource type.<p>
       *
       * @param cms the cms context
       * @param resourceType the resource type name
       * @param userAgent the user agent header
       * @param loadDefault <code>true</code> to force the default editor
       *
       * @return the absolute path to the editor
       */
      String getEditorUri(CmsObject cms, String resourceType, String userAgent, boolean loadDefault);
  
      /**
       * Returns the editor URI which will be used for the selected resource in the OpenCms VFS to the editor selector class.<p>
       *
       * @param resource the selected resource
       * @param jsp the CmsJspActionElement
       *
       * @return the absolute path to the editor that will be displayed or <code>null</code> if resource is not editable
       *
       * @throws CmsException if something goes wrong
       */
      String getEditorUri(String resource, CmsJspActionElement jsp) throws CmsException;
  
  }
  