org.opencms.workplace.editors

接口 I_CmsPreEditorActionDefinition

所有超级接口:

I_CmsConfigurationParameterHandler

所有已知实现类:

A_CmsPreEditorActionDefinition, CmsPreEditorActionDefinitionXmlContent

public interface I_CmsPreEditorActionDefinition
extends I_CmsConfigurationParameterHandler

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

从以下版本开始:

6.5.4

字段概要

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

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

方法概要

方法

限定符和类型	方法和说明
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.
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	setResourceTypeName(java.lang.String resourceTypeName) Sets the resource type name for which the action should be performed.

从接口继承的方法 org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

方法详细资料

doPreAction

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

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

参数:

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

getResourceType

I_CmsResourceType getResourceType()

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

返回:

the resource type

getResourceTypeName

java.lang.String getResourceTypeName()

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

返回:

the resource type name

setResourceTypeName

void setResourceTypeName(java.lang.String resourceTypeName)

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

参数:

resourceTypeName - the resource type name