Package org.opencms.workplace.editors

Class A_CmsPreEditorActionDefinition

java.lang.Object

org.opencms.workplace.editors.A_CmsPreEditorActionDefinition

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsPreEditorActionDefinition

Direct Known Subclasses:

CmsPreEditorActionDefinitionXmlContent

public abstract class A_CmsPreEditorActionDefinition
extends 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.

Since:

6.5.4

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsParameterConfiguration	m_configuration	Configuration parameters.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
A_CmsPreEditorActionDefinition()	Constructor, without parameters.

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
abstract boolean	doPreAction(CmsResource resource, CmsDialog dialog, 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.
String	getResourceTypeName()	Returns the resource type name for which the action should be performed.
final void	initConfiguration()	Initializes a configuration after all parameters have been added.
void	setResourceTypeName(String resourceTypeName)	Sets the resource type name for which the action should be performed.

Methods inherited from class java.lang.Object

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

Field Details

m_configuration

protected CmsParameterConfiguration m_configuration

Configuration parameters.

Constructor Details

A_CmsPreEditorActionDefinition

public A_CmsPreEditorActionDefinition()

Constructor, without parameters.

Method Details

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

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

doPreAction

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

Description copied from interface: 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.

Specified by:

doPreAction in interface I_CmsPreEditorActionDefinition

Parameters:

resource - the resource to be edited

dialog - the dialog instance

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

Returns:

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

Throws:

Exception - if something goes wrong

See Also:

• I_CmsPreEditorActionDefinition.doPreAction(org.opencms.file.CmsResource, org.opencms.workplace.CmsDialog, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

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

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

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

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getResourceType

public I_CmsResourceType getResourceType()

Description copied from interface: I_CmsPreEditorActionDefinition

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

Specified by:

getResourceType in interface I_CmsPreEditorActionDefinition

Returns:

the resource type

See Also:

• I_CmsPreEditorActionDefinition.getResourceType()

getResourceTypeName

public String getResourceTypeName()

Description copied from interface: I_CmsPreEditorActionDefinition

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

Specified by:

getResourceTypeName in interface I_CmsPreEditorActionDefinition

Returns:

the resource type name

See Also:

• I_CmsPreEditorActionDefinition.getResourceTypeName()

initConfiguration

public final void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

setResourceTypeName

public void setResourceTypeName(String resourceTypeName)

Description copied from interface: I_CmsPreEditorActionDefinition

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

Specified by:

setResourceTypeName in interface I_CmsPreEditorActionDefinition

Parameters:

resourceTypeName - the resource type name

See Also:

• I_CmsPreEditorActionDefinition.setResourceTypeName(java.lang.String)