org.opencms.workplace.editors.directedit

类 CmsDirectEditDefaultProvider

java.lang.Object

org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider

org.opencms.workplace.editors.directedit.CmsDirectEditDefaultProvider

所有已实现的接口:

java.lang.Cloneable, I_CmsConfigurationParameterHandler, I_CmsDirectEditProvider

直接已知子类:

CmsDirectEditJQueryProvider, CmsDirectEditTextButtonProvider

public class CmsDirectEditDefaultProvider
extends A_CmsDirectEditProvider

Provider for the OpenCms default graphical "direct edit" buttons.

Since OpenCms version 6.2.3, this provider is configured as the standard direct edit provider in a common OpenCms installation.

This provider DOES NOT support CmsDirectEditMode.MANUAL mode.

从以下版本开始:

6.2.3

字段概要

字段

限定符和类型	字段和说明
protected int	m_lastPermissionMode Indicates the permissions for the last element the was opened.

从类继承的字段 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

构造器概要

构造器

构造器和说明
CmsDirectEditDefaultProvider()

方法概要

方法

限定符和类型	方法和说明
java.lang.String	endDirectEditDisabled() Returns the end HTML for a disabled direct edit button.
java.lang.String	endDirectEditEnabled() Returns the end HTML for an enabled direct edit button.
protected java.lang.String	getContentAsString(CmsFile file) Helper method to convert the content of a resource to a string.
java.lang.String	getDirectEditIncludes(CmsDirectEditParams params) Returns the direct edit include HTML to insert in the page beginning.
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 default provider does not support manual button placement.
I_CmsDirectEditProvider	newInstance() Creates a new instance of this direct edit provider with the same basic configuration.
protected CmsMacroResolver	prepareMacroResolverForIncludes(CmsDirectEditParams params) Prepares the macro resolver which is used to process the included text file.
java.lang.String	startDirectEditDisabled(CmsDirectEditParams params, CmsDirectEditResourceInfo resourceInfo) Returns the start HTML for a disabled direct edit button.
java.lang.String	startDirectEditEnabled(CmsDirectEditParams params, CmsDirectEditResourceInfo resourceInfo) Returns the start HTML for an enabled direct edit button.

从类继承的方法 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

字段详细资料

m_lastPermissionMode

protected int m_lastPermissionMode

Indicates the permissions for the last element the was opened.

构造器详细资料

CmsDirectEditDefaultProvider

public CmsDirectEditDefaultProvider()

方法详细资料

endDirectEditDisabled

public java.lang.String endDirectEditDisabled()

Returns the end HTML for a disabled direct edit button.

返回:

the end HTML for a disabled direct edit button

endDirectEditEnabled

public java.lang.String endDirectEditEnabled()

Returns the end HTML for an enabled direct edit button.

返回:

the end HTML for an enabled direct edit button

getDirectEditIncludes

public java.lang.String getDirectEditIncludes(CmsDirectEditParams params)

Returns the direct edit include HTML to insert in the page beginning.

t

参数:

params - the parameters for the direct edit includes

返回:

the direct edit include HTML to insert in the page beginning

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 default 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()

startDirectEditDisabled

public java.lang.String startDirectEditDisabled(CmsDirectEditParams params,
                                       CmsDirectEditResourceInfo resourceInfo)

Returns the start HTML for a disabled direct edit button.

参数:

params - the direct edit parameters

resourceInfo - contains information about the resource to edit

返回:

the start HTML for a disabled direct edit button

startDirectEditEnabled

public java.lang.String startDirectEditEnabled(CmsDirectEditParams params,
                                      CmsDirectEditResourceInfo resourceInfo)

Returns the start HTML for an enabled direct edit button.

参数:

params - the direct edit parameters

resourceInfo - contains information about the resource to edit

返回:

the start HTML for an enabled direct edit button

getContentAsString

protected java.lang.String getContentAsString(CmsFile file)
                                       throws CmsException

Helper method to convert the content of a resource to a string.

参数:

file - the file

返回:

the file content as a string

抛出:

CmsException - if something goes wrong

prepareMacroResolverForIncludes

protected CmsMacroResolver prepareMacroResolverForIncludes(CmsDirectEditParams params)

Prepares the macro resolver which is used to process the included text file.

参数:

params - the direct edit parameters

返回:

the macro resolver