org.opencms.workplace.editors.directedit

类 CmsDirectEditJspIncludeProvider

java.lang.Object

org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider

org.opencms.workplace.editors.directedit.CmsDirectEditJspIncludeProvider

所有已实现的接口:

java.lang.Cloneable, I_CmsConfigurationParameterHandler, I_CmsDirectEditProvider

public class CmsDirectEditJspIncludeProvider
extends A_CmsDirectEditProvider

Direct edit provider that uses the same JSP include based logic that has been the default before the 6.2.3 release.

Even though placing the HTML of the direct edit buttons appears to be more "flexible" at first, there is a large overhead invloved using this provider as compared to an implementation like CmsDirectEditDefaultProvider. For every direct edit button on a page, a JSP include is processed twice using this provider, one include for the opening and one for the closing HTML. A JSP include is a costly operation, which means the performance of a website is be impacted if many content managers work on the system that makes great use of direct edit with a lot of elements on a page. In order to avoid this performance impact, OpenCms since version 6.2.3 uses the CmsDirectEditDefaultProvider by default.

This provider DOES NOT support CmsDirectEditMode.MANUAL mode.

从以下版本开始:

6.2.3

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DIRECT_EDIT_AREA_END Prefix for direct edit end elements, used on JPS pages that supply the direct edit html.
static java.lang.String	DIRECT_EDIT_AREA_START Prefix for direct edit start elements, used on JPS pages that supply the direct edit html.
static java.lang.String	DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT Default direct edit include file URI.
static java.lang.String	DIRECT_EDIT_INCLUDES Element name for direct edit includes.
static java.lang.String	DIRECT_EDIT_PARAM_BUTTONSTYLE Key to identify the edit button style, used on JPS pages that supply the direct edit html.
static java.lang.String	DIRECT_EDIT_PARAM_ELEMENT Key to identify the edit element, used on JPS pages that supply the direct edit html.
static java.lang.String	DIRECT_EDIT_PARAM_LOCALE Key to identify the edit language, used on JPS pages that supply the direct edit html.
static java.lang.String	DIRECT_EDIT_PARAM_NEWLINK Key to identify the link to use for the "new" button (if enabled).
static java.lang.String	DIRECT_EDIT_PARAM_OPTIONS Key to identify additional direct edit options, used e.g. to control which direct edit buttons are displayed
static java.lang.String	DIRECT_EDIT_PARAM_TARGET Key to identify the edit target, used on JPS pages that supply the direct edit html.
protected java.lang.String	m_editElement The last direct edit element.
protected java.lang.String	m_editTarget The last direct edit target.
protected java.lang.String	m_permissions The last calculated direct edit permissions.

从类继承的字段 org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider

INCLUDE_FILE_DEFAULT, m_cms, m_configurationParameters, m_editButtonStyle, m_fileName, m_messages, m_mode, m_rnd

从接口继承的字段 org.opencms.workplace.editors.directedit.I_CmsDirectEditProvider

ATTRIBUTE_DIRECT_EDIT_PROVIDER, ATTRIBUTE_DIRECT_EDIT_PROVIDER_PARAMS

从接口继承的字段 org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
CmsDirectEditJspIncludeProvider()

方法概要

方法

限定符和类型	方法和说明
static java.lang.String	includeDirectEditElement(javax.servlet.jsp.PageContext context, java.lang.String jspIncludeFile, java.lang.String element, java.lang.String editTarget, java.lang.String editElement, java.lang.String editOptions, java.lang.String editPermissions, java.lang.String createLink) Includes the "direct edit" element that adds HTML for the editable area to the output page.
void	init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName) Initialize method for a new instance of the direct edit provider.
void	insertDirectEditEnd(javax.servlet.jsp.PageContext context) Inserts the "end direct edit" HTML in the provided JSP page context.
void	insertDirectEditIncludes(javax.servlet.jsp.PageContext context, CmsDirectEditParams params) Inserts the "direct edit header" HTML in the provided JSP page context.
boolean	insertDirectEditStart(javax.servlet.jsp.PageContext context, CmsDirectEditParams params) Inserts the "start direct edit" HTML in the provided JSP page context.
boolean	isManual(CmsDirectEditMode mode) Returns false because the JSP include provider does not support manual button placement.
I_CmsDirectEditProvider	newInstance() Creates a new instance of this direct edit provider with the same basic configuration.

从类继承的方法 org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider

addConfigurationParameter, getConfiguration, getLink, getNextDirectEditId, getResourceInfo, initConfiguration, insertDirectEditEmptyList, print

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

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

字段详细资料

DIRECT_EDIT_AREA_END

public static final java.lang.String DIRECT_EDIT_AREA_END

Prefix for direct edit end elements, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_AREA_START

public static final java.lang.String DIRECT_EDIT_AREA_START

Prefix for direct edit start elements, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT

public static final java.lang.String DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT

Default direct edit include file URI.

另请参阅:

常量字段值

DIRECT_EDIT_INCLUDES

public static final java.lang.String DIRECT_EDIT_INCLUDES

Element name for direct edit includes.

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_BUTTONSTYLE

public static final java.lang.String DIRECT_EDIT_PARAM_BUTTONSTYLE

Key to identify the edit button style, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_ELEMENT

public static final java.lang.String DIRECT_EDIT_PARAM_ELEMENT

Key to identify the edit element, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_LOCALE

public static final java.lang.String DIRECT_EDIT_PARAM_LOCALE

Key to identify the edit language, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_NEWLINK

public static final java.lang.String DIRECT_EDIT_PARAM_NEWLINK

Key to identify the link to use for the "new" button (if enabled).

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_OPTIONS

public static final java.lang.String DIRECT_EDIT_PARAM_OPTIONS

Key to identify additional direct edit options, used e.g. to control which direct edit buttons are displayed

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_TARGET

public static final java.lang.String DIRECT_EDIT_PARAM_TARGET

Key to identify the edit target, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

m_editElement

protected java.lang.String m_editElement

The last direct edit element.

m_editTarget

protected java.lang.String m_editTarget

The last direct edit target.

m_permissions

protected java.lang.String m_permissions

The last calculated direct edit permissions.

构造器详细资料

CmsDirectEditJspIncludeProvider

public CmsDirectEditJspIncludeProvider()

方法详细资料

includeDirectEditElement

public static java.lang.String includeDirectEditElement(javax.servlet.jsp.PageContext context,
                                        java.lang.String jspIncludeFile,
                                        java.lang.String element,
                                        java.lang.String editTarget,
                                        java.lang.String editElement,
                                        java.lang.String editOptions,
                                        java.lang.String editPermissions,
                                        java.lang.String createLink)
                                                 throws javax.servlet.jsp.JspException

Includes the "direct edit" element that adds HTML for the editable area to the output page.

参数:

context - the current JSP page context

jspIncludeFile - the VFS path of the JSP that contains the direct edit HTML fragments

element - the editor element to include

editTarget - the direct edit target

editElement - the direct edit element

editOptions - the direct edit options

editPermissions - the direct edit permissions

createLink - the direct edit create link

返回:

the direct edit permissions

抛出:

javax.servlet.jsp.JspException - in case something goes wrong

init

public void init(CmsObject cms,
        CmsDirectEditMode mode,
        java.lang.String fileName)

从接口复制的说明: I_CmsDirectEditProvider

Initialize method for a new instance of the direct edit provider.

指定者:

init 在接口中 I_CmsDirectEditProvider

覆盖:

init 在类中 A_CmsDirectEditProvider

参数:

cms - the current users OpenCms context

mode - the direct edit mode to use

fileName - link to a file that contains the direct edit HTML elements (optional)

另请参阅:

A_CmsDirectEditProvider.init(org.opencms.file.CmsObject, org.opencms.workplace.editors.directedit.CmsDirectEditMode, java.lang.String)

insertDirectEditEnd

public void insertDirectEditEnd(javax.servlet.jsp.PageContext context)
                         throws javax.servlet.jsp.JspException

从接口复制的说明: I_CmsDirectEditProvider

Inserts the "end direct edit" HTML in the provided JSP page context.

参数:

context - the JSP page context to insert the HTML to

抛出:

javax.servlet.jsp.JspException - in case something goes wrong

另请参阅:

I_CmsDirectEditProvider.insertDirectEditEnd(javax.servlet.jsp.PageContext)

insertDirectEditIncludes

public void insertDirectEditIncludes(javax.servlet.jsp.PageContext context,
                            CmsDirectEditParams params)
                              throws javax.servlet.jsp.JspException

从接口复制的说明: I_CmsDirectEditProvider

Inserts the "direct edit header" HTML in the provided JSP page context.

参数:

context - the JSP page context to insert the HTML to

params - the parameters for the direct edit includes

抛出:

javax.servlet.jsp.JspException - in case something goes wrong

另请参阅:

I_CmsDirectEditProvider.insertDirectEditIncludes(javax.servlet.jsp.PageContext, org.opencms.workplace.editors.directedit.CmsDirectEditParams)

insertDirectEditStart

public boolean insertDirectEditStart(javax.servlet.jsp.PageContext context,
                            CmsDirectEditParams params)
                              throws javax.servlet.jsp.JspException

从接口复制的说明: I_CmsDirectEditProvider

Inserts the "start direct edit" HTML in the provided JSP page context.

参数:

context - the JSP page context to insert the HTML to

params - the parameters for the direct edit call

返回:

true in case a direct edit element was opened, false otherwise

抛出:

javax.servlet.jsp.JspException - in case something goes wrong

另请参阅:

I_CmsDirectEditProvider.insertDirectEditStart(javax.servlet.jsp.PageContext, org.opencms.workplace.editors.directedit.CmsDirectEditParams)

isManual

public boolean isManual(CmsDirectEditMode mode)

Returns false because the JSP include provider does not support manual button placement.

指定者:

isManual 在接口中 I_CmsDirectEditProvider

覆盖:

isManual 在类中 A_CmsDirectEditProvider

参数:

mode - the mode of the current direct edit element

返回:

true if this provider (currently) operates in manual mode

另请参阅:

I_CmsDirectEditProvider.isManual(org.opencms.workplace.editors.directedit.CmsDirectEditMode)

newInstance

public I_CmsDirectEditProvider newInstance()

从接口复制的说明: I_CmsDirectEditProvider

Creates a new instance of this direct edit provider with the same basic configuration.

返回:

a new instance of this direct edit provider with the same basic configuration

另请参阅:

I_CmsDirectEditProvider.newInstance()