Package org.opencms.workplace.editors

Class CmsEditorHandler

java.lang.Object

org.opencms.workplace.editors.CmsEditorHandler

All Implemented Interfaces:

I_CmsEditorHandler

public class CmsEditorHandler
extends Object
implements I_CmsEditorHandler

This editor handler class returns the editor URI depending on various factors.

Editor selection criteria:

• the user preferences
• the users current browser
• the resource type

Since:

6.0.0

See Also:

• I_CmsEditorHandler
• CmsWorkplaceEditorManager

Constructor Summary

Constructors

Constructor	Description
CmsEditorHandler()

Method Summary

Modifier and Type	Method	Description
String	getEditorUri(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.
String	getEditorUri(CmsObject cms, String resourceType, String userAgent, boolean loadDefault)	Returns the editor URI which will be used for the selected resource type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsEditorHandler

public CmsEditorHandler()

Method Details

getEditorUri

public String getEditorUri(CmsObject cms,
 String resourceType,
 String userAgent,
 boolean loadDefault)

Description copied from interface: I_CmsEditorHandler

Returns the editor URI which will be used for the selected resource type.

Specified by:

getEditorUri in interface I_CmsEditorHandler

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

See Also:

• I_CmsEditorHandler.getEditorUri(org.opencms.file.CmsObject, java.lang.String, java.lang.String, boolean)

getEditorUri

public String getEditorUri(String resource,
 CmsJspActionElement jsp)
                    throws CmsException

Description copied from interface: I_CmsEditorHandler

Returns the editor URI which will be used for the selected resource in the OpenCms VFS to the editor selector class.

Specified by:

getEditorUri in interface I_CmsEditorHandler

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

See Also:

• I_CmsEditorHandler.getEditorUri(java.lang.String, CmsJspActionElement)