Package org.opencms.workplace.editors
Class CmsEditorHandler
- java.lang.Object
-
- org.opencms.workplace.editors.CmsEditorHandler
-
- All Implemented Interfaces:
I_CmsEditorHandler
public class CmsEditorHandler extends java.lang.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
All Methods Instance Methods Concrete 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.
-
-
-
Constructor Detail
-
CmsEditorHandler
public CmsEditorHandler()
-
-
Method Detail
-
getEditorUri
public java.lang.String getEditorUri(CmsObject cms, java.lang.String resourceType, java.lang.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 interfaceI_CmsEditorHandler
- Parameters:
cms
- the cms contextresourceType
- the resource type nameuserAgent
- the user agent headerloadDefault
-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 java.lang.String getEditorUri(java.lang.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 interfaceI_CmsEditorHandler
- Parameters:
resource
- the selected resourcejsp
- 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)
-
-