Interface I_CmsEditorHandler

  • All Known Implementing Classes:
    CmsEditorHandler

    public interface I_CmsEditorHandler
    Provides a method for selecting an individual file editor.

    You can define the class of your own editor handler in the OpenCms XML configuration files. changing the <class> subnode of the system node <editorhandler> to another value. The class you enter must implement this interface to obtain the URI of the displayed editor.

    Since:
    6.0.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getEditorUri​(java.lang.String resource, CmsJspActionElement jsp)
      Returns the editor URI which will be used for the selected resource in the OpenCms VFS to the editor selector class.
      java.lang.String getEditorUri​(CmsObject cms, java.lang.String resourceType, java.lang.String userAgent, boolean loadDefault)
      Returns the editor URI which will be used for the selected resource type.
    • Method Detail

      • getEditorUri

        java.lang.String getEditorUri​(CmsObject cms,
                                      java.lang.String resourceType,
                                      java.lang.String userAgent,
                                      boolean loadDefault)
        Returns the editor URI which will be used for the selected resource type.

        Parameters:
        cms - the cms context
        resourceType - the resource type name
        userAgent - the user agent header
        loadDefault - true to force the default editor
        Returns:
        the absolute path to the editor
      • getEditorUri

        java.lang.String getEditorUri​(java.lang.String resource,
                                      CmsJspActionElement jsp)
                               throws CmsException
        Returns the editor URI which will be used for the selected resource in the OpenCms VFS to the editor selector class.

        Parameters:
        resource - the selected resource
        jsp - the CmsJspActionElement
        Returns:
        the absolute path to the editor that will be displayed or null if resource is not editable
        Throws:
        CmsException - if something goes wrong