org.opencms.workplace.editors

类 CmsWorkplaceEditorManager

java.lang.Object

org.opencms.workplace.editors.CmsWorkplaceEditorManager

public class CmsWorkplaceEditorManager
extends java.lang.Object

The editor manager stores information about all available configured editors in OpenCms.

This class provides methods and constants to select the right editor according to:

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

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	EDITOR_CONFIGURATION_FILENAME The filename of the editor configuration XML file.
static java.lang.String	EDITOR_FILENAME The filename of the editor JSP.

构造器概要

构造器

构造器和说明
CmsWorkplaceEditorManager(CmsObject cms) Creates a new editor manager.

方法概要

方法

限定符和类型	方法和说明
static boolean	checkAcaciaEditorAvailable(CmsObject cms, CmsResource resource) Checks whether GWT widgets are available for all fields of a content.
java.util.Map<java.lang.String,java.util.SortedMap<java.lang.Float,CmsWorkplaceEditorConfiguration>>	getConfigurableEditors() Returns a map of configurable editors for the workplace preferences dialog.
protected java.lang.String	getDefaultEditorUri(CmsRequestContext context, java.lang.String resourceType, java.lang.String userAgent) Returns the default editor URI for the current resource type.
CmsWorkplaceEditorConfiguration	getEditorConfiguration(java.lang.String name) Gets the editor configuration with the given name.
protected java.util.List<CmsWorkplaceEditorConfiguration>	getEditorConfigurations() Returns the editor configuration objects.
protected java.lang.String	getEditorUri(CmsRequestContext context, java.lang.String resourceType, java.lang.String userAgent) Returns the editor URI for the current resource type.
java.lang.String	getWidgetEditor(CmsRequestContext context, java.lang.String userAgent) Returns the editor URI for the current resource type.

从类继承的方法 java.lang.Object

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

字段详细资料

EDITOR_CONFIGURATION_FILENAME

public static final java.lang.String EDITOR_CONFIGURATION_FILENAME

The filename of the editor configuration XML file.

另请参阅:

常量字段值

EDITOR_FILENAME

public static final java.lang.String EDITOR_FILENAME

The filename of the editor JSP.

另请参阅:

常量字段值

构造器详细资料

CmsWorkplaceEditorManager

public CmsWorkplaceEditorManager(CmsObject cms)

Creates a new editor manager.

参数:

cms - an OpenCms context object that must have been initialized with "Admin" permissions

方法详细资料

checkAcaciaEditorAvailable

public static boolean checkAcaciaEditorAvailable(CmsObject cms,
                                 CmsResource resource)
                                          throws CmsException

Checks whether GWT widgets are available for all fields of a content.

参数:

cms - the current CMS context

resource - the resource to check

返回:

false if for some fields the new Acacia widgets are not available

抛出:

CmsException - if something goes wrong

getConfigurableEditors

public java.util.Map<java.lang.String,java.util.SortedMap<java.lang.Float,CmsWorkplaceEditorConfiguration>> getConfigurableEditors()

Returns a map of configurable editors for the workplace preferences dialog.

This map has the resource type name as key, the value is a sorted map with the ranking as key and a CmsWorkplaceEditorConfiguration object as value.

返回:

configurable editors for the workplace preferences dialog

getEditorConfiguration

public CmsWorkplaceEditorConfiguration getEditorConfiguration(java.lang.String name)

Gets the editor configuration with the given name.

参数:

name - the name of the editor configuration

返回:

the editor configuration

getWidgetEditor

public java.lang.String getWidgetEditor(CmsRequestContext context,
                               java.lang.String userAgent)

Returns the editor URI for the current resource type.

参数:

context - the request context

userAgent - the user agent String that identifies the browser

返回:

a valid editor URI for the resource type or null, if no editor matches

getDefaultEditorUri

protected java.lang.String getDefaultEditorUri(CmsRequestContext context,
                                   java.lang.String resourceType,
                                   java.lang.String userAgent)

Returns the default editor URI for the current resource type.

参数:

context - the request context

resourceType - the current resource type

userAgent - the user agent String that identifies the browser

返回:

a valid default editor URI for the resource type or null, if no editor matches

getEditorConfigurations

protected java.util.List<CmsWorkplaceEditorConfiguration> getEditorConfigurations()

Returns the editor configuration objects.

返回:

the editor configuration objects

getEditorUri

protected java.lang.String getEditorUri(CmsRequestContext context,
                            java.lang.String resourceType,
                            java.lang.String userAgent)

Returns the editor URI for the current resource type.

参数:

context - the request context

resourceType - the current resource type

userAgent - the user agent String that identifies the browser

返回:

a valid editor URI for the resource type or null, if no editor matches