org.opencms.workplace.editors

类 A_CmsPreEditorActionDefinition

java.lang.Object

org.opencms.workplace.editors.A_CmsPreEditorActionDefinition

所有已实现的接口:

I_CmsConfigurationParameterHandler, I_CmsPreEditorActionDefinition

直接已知子类:

CmsPreEditorActionDefinitionXmlContent

public abstract class A_CmsPreEditorActionDefinition
extends java.lang.Object
implements I_CmsPreEditorActionDefinition

Defines an action to be performed before the workplace editor is opened for the first time.

Implements the basic methods to handle the resource type.

从以下版本开始:

6.5.4

字段概要

字段

限定符和类型	字段和说明
protected CmsParameterConfiguration	m_configuration Configuration parameters.

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

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
A_CmsPreEditorActionDefinition() Constructor, without parameters.

方法概要

方法

限定符和类型	方法和说明
void	addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue) Adds a configuration parameter to this parameter configurable class instance.
abstract boolean	doPreAction(CmsResource resource, CmsDialog dialog, java.lang.String originalParams) Returns if an action has to be performed before opening the editor depending on the resource to edit and eventual request parameter values.
CmsParameterConfiguration	getConfiguration() Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
I_CmsResourceType	getResourceType() Returns the resource type for which the action should be performed.
java.lang.String	getResourceTypeName() Returns the resource type name for which the action should be performed.
void	initConfiguration() Initializes a configuration after all parameters have been added.
void	setResourceTypeName(java.lang.String resourceTypeName) Sets the resource type name for which the action should be performed.

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

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

字段详细资料

m_configuration

protected CmsParameterConfiguration m_configuration

Configuration parameters.

构造器详细资料

A_CmsPreEditorActionDefinition

public A_CmsPreEditorActionDefinition()

Constructor, without parameters.

方法详细资料

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)

doPreAction

public abstract boolean doPreAction(CmsResource resource,
                  CmsDialog dialog,
                  java.lang.String originalParams)
                             throws java.lang.Exception

从接口复制的说明: I_CmsPreEditorActionDefinition

Returns if an action has to be performed before opening the editor depending on the resource to edit and eventual request parameter values.

指定者:

doPreAction 在接口中 I_CmsPreEditorActionDefinition

参数:

resource - the resource to be edited

dialog - the dialog instance

originalParams - the original request parameters as String passed to the editor

返回:

true if an action has to be performed before opening the editor

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

I_CmsPreEditorActionDefinition.doPreAction(org.opencms.file.CmsResource, org.opencms.workplace.CmsDialog, 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()

getResourceType

public I_CmsResourceType getResourceType()

从接口复制的说明: I_CmsPreEditorActionDefinition

Returns the resource type for which the action should be performed.

指定者:

getResourceType 在接口中 I_CmsPreEditorActionDefinition

返回:

the resource type

另请参阅:

I_CmsPreEditorActionDefinition.getResourceType()

getResourceTypeName

public java.lang.String getResourceTypeName()

从接口复制的说明: I_CmsPreEditorActionDefinition

Returns the resource type name for which the action should be performed.

指定者:

getResourceTypeName 在接口中 I_CmsPreEditorActionDefinition

返回:

the resource type name

另请参阅:

I_CmsPreEditorActionDefinition.getResourceTypeName()

initConfiguration

public final void initConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

指定者:

initConfiguration 在接口中 I_CmsConfigurationParameterHandler

另请参阅:

I_CmsConfigurationParameterHandler.initConfiguration()

setResourceTypeName

public void setResourceTypeName(java.lang.String resourceTypeName)

从接口复制的说明: I_CmsPreEditorActionDefinition

Sets the resource type name for which the action should be performed.

指定者:

setResourceTypeName 在接口中 I_CmsPreEditorActionDefinition

参数:

resourceTypeName - the resource type name

另请参阅:

I_CmsPreEditorActionDefinition.setResourceTypeName(java.lang.String)