org.opencms.workplace.editors
Class A_CmsPreEditorActionDefinition

java.lang.Object
  extended by org.opencms.workplace.editors.A_CmsPreEditorActionDefinition
All Implemented Interfaces:
I_CmsPreEditorActionDefinition
Direct Known Subclasses:
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.

Since:
6.5.4
Version:
$Revision: 1.6 $
Author:
Andreas Zahner

Constructor Summary
A_CmsPreEditorActionDefinition()
          Constructor, without parameters.
 
Method Summary
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.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

A_CmsPreEditorActionDefinition

public A_CmsPreEditorActionDefinition()
Constructor, without parameters.

Method Detail

doPreAction

public abstract boolean doPreAction(CmsResource resource,
                                    CmsDialog dialog,
                                    java.lang.String originalParams)
                             throws java.lang.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:
java.lang.Exception - if something goes wrong
See Also:
I_CmsPreEditorActionDefinition.doPreAction(org.opencms.file.CmsResource, org.opencms.workplace.CmsDialog, java.lang.String)

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 java.lang.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()

setResourceTypeName

public void setResourceTypeName(java.lang.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)