org.opencms.workplace.editors.directedit

类 A_CmsDirectEditProvider

java.lang.Object

org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider

所有已实现的接口:

java.lang.Cloneable, I_CmsConfigurationParameterHandler, I_CmsDirectEditProvider

直接已知子类:

CmsAdvancedDirectEditProvider, CmsDirectEditDefaultProvider, CmsDirectEditJspIncludeProvider

public abstract class A_CmsDirectEditProvider
extends java.lang.Object
implements I_CmsDirectEditProvider

Basic functions for direct edit providers.

从以下版本开始:

6.2.3

字段概要

字段

限定符和类型	字段和说明
protected static java.lang.String	INCLUDE_FILE_DEFAULT Default direct edit include file URI for post 6.2.3 direct edit providers.
protected CmsObject	m_cms The current users OpenCms context.
protected CmsParameterConfiguration	m_configurationParameters The parameters form the configuration.
protected int	m_editButtonStyle The editor button style to use.
protected java.lang.String	m_fileName Value of the "fileName" parameter.
protected CmsMessages	m_messages Used to access the editor messages.
protected CmsDirectEditMode	m_mode Indicates which direct edit mode is used.
protected java.util.Random	m_rnd Used to generate the edit id's.

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

构造器概要

构造器

构造器和说明
A_CmsDirectEditProvider()

方法概要

方法

限定符和类型	方法和说明
void	addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue) Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration() Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
protected java.lang.String	getLink(java.lang.String target) Returns the given link resolved according to the OpenCms context and export rules.
protected java.lang.String	getNextDirectEditId() Returns the next random edit id.
CmsDirectEditResourceInfo	getResourceInfo(java.lang.String resourceName) Calculates the direct edit resource information for the given VFS resource.
void	init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName) Initialize method for a new instance of the direct edit provider.
void	initConfiguration() Initializes a configuration after all parameters have been added.
void	insertDirectEditEmptyList(javax.servlet.jsp.PageContext context, CmsDirectEditParams params) Inserts the direct edit HTML for empty lists in the provided JSP page context.
boolean	isManual(CmsDirectEditMode mode) Returns true if this provider (currently) operates in manual mode.
protected void	print(javax.servlet.jsp.PageContext context, java.lang.String content) Prints the given content string to the given page context.

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

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

从接口继承的方法 org.opencms.workplace.editors.directedit.I_CmsDirectEditProvider

insertDirectEditEnd, insertDirectEditIncludes, insertDirectEditStart, newInstance

字段详细资料

INCLUDE_FILE_DEFAULT

protected static final java.lang.String INCLUDE_FILE_DEFAULT

Default direct edit include file URI for post 6.2.3 direct edit providers.

另请参阅:

常量字段值

m_cms

protected CmsObject m_cms

The current users OpenCms context.

m_configurationParameters

protected CmsParameterConfiguration m_configurationParameters

The parameters form the configuration.

m_editButtonStyle

protected int m_editButtonStyle

The editor button style to use.

m_fileName

protected java.lang.String m_fileName

Value of the "fileName" parameter.

m_messages

protected CmsMessages m_messages

Used to access the editor messages.

m_mode

protected CmsDirectEditMode m_mode

Indicates which direct edit mode is used.

m_rnd

protected java.util.Random m_rnd

Used to generate the edit id's.

构造器详细资料

A_CmsDirectEditProvider

public A_CmsDirectEditProvider()

方法详细资料

addConfigurationParameter

public void addConfigurationParameter(java.lang.String paramName,
                             java.lang.String paramValue)

从接口复制的说明: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

指定者:

addConfigurationParameter 在接口中 I_CmsConfigurationParameterHandler

参数:

paramName - the name of the parameter

paramValue - the value for the parameter

另请参阅:

I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

指定者:

getConfiguration 在接口中 I_CmsConfigurationParameterHandler

返回:

the parameters of this configurable class instance, or null if the class does not need any parameters

另请参阅:

I_CmsConfigurationParameterHandler.getConfiguration()

getResourceInfo

public CmsDirectEditResourceInfo getResourceInfo(java.lang.String resourceName)

Calculates the direct edit resource information for the given VFS resource.

This includes the direct edit permissions. If the permissions are not CmsDirectEditPermissions.INACTIVE, then the resource and lock information is also included in the result.

参数:

resourceName - the name of the VFS resource to get the direct edit info for

返回:

the direct edit resource information for the given VFS resource

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

参数:

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)

另请参阅:

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

initConfiguration

public void initConfiguration()
                       throws CmsConfigurationException

从接口复制的说明: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

指定者:

initConfiguration 在接口中 I_CmsConfigurationParameterHandler

抛出:

CmsConfigurationException - if something goes wrong

另请参阅:

I_CmsConfigurationParameterHandler.initConfiguration()

insertDirectEditEmptyList

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

从接口复制的说明: I_CmsDirectEditProvider

Inserts the direct edit HTML for empty lists in the provided JSP page context.

指定者:

insertDirectEditEmptyList 在接口中 I_CmsDirectEditProvider

参数:

context - the JSP page context to insert the HTML to

params - the parameters for the direct edit call

抛出:

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

另请参阅:

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

isManual

public boolean isManual(CmsDirectEditMode mode)

从接口复制的说明: I_CmsDirectEditProvider

Returns true if this provider (currently) operates in manual mode.

In manual mode the direct edit HTML is inserted with <cms:enditable mode="manual" /> tags. Otherwise the direct edit HTML is automatically inserted in the current page.

Some providers may not be able to operate in manual mode. These will always return false.

指定者:

isManual 在接口中 I_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)

getLink

protected java.lang.String getLink(java.lang.String target)

Returns the given link resolved according to the OpenCms context and export rules.

参数:

target - the link target to resolve

返回:

the given link resolved according to the OpenCms context and export rules

getNextDirectEditId

protected java.lang.String getNextDirectEditId()

Returns the next random edit id.

Random edit id's are used because to separate multiple direct edit buttons on one page.

返回:

the next random edit id

print

protected void print(javax.servlet.jsp.PageContext context,
         java.lang.String content)
              throws javax.servlet.jsp.JspException

Prints the given content string to the given page context.

Does not print anything if the content is null.

参数:

context - the JSP page context to print the content to

content - the content to print

抛出:

javax.servlet.jsp.JspException - in case the content could not be written to the page conext