org.opencms.ui.actions

Class A_CmsEditFileAction

java.lang.Object

org.opencms.ui.actions.A_CmsWorkplaceAction

org.opencms.ui.actions.A_CmsEditFileAction

All Implemented Interfaces:

I_CmsADEAction, I_CmsWorkplaceAction, I_CmsHasMenuItemVisibility

Direct Known Subclasses:

CmsEditContentAction

public abstract class A_CmsEditFileAction
extends A_CmsWorkplaceAction
implements I_CmsADEAction

Action to edit a file given by the file param.

Used within the ADE context only.

Constructor Summary

Constructors

Constructor and Description
A_CmsEditFileAction()

Method Summary

Modifier and Type	Method and Description
void	executeAction(I_CmsDialogContext context) Executes the action.
protected boolean	existsFile(I_CmsDialogContext context) Checks whether the file specified by the file param and the given context exists and is visible.
java.lang.String	getCommandClassName() Returns the client side command to execute.
protected abstract java.lang.String	getFileParam() Returns the file parameter.
java.lang.String	getJspPath() Returns the optional dialog JSP.
java.util.Map<java.lang.String,java.lang.String>	getParams() Returns the optional command parameters.
CmsMenuItemVisibilityMode	getVisibility(CmsObject cms, java.util.List<CmsResource> resources) Gets the visibility for the current resource and CMS context.
boolean	isAdeSupported() Returns whether the ADE context is supported.

Methods inherited from class org.opencms.ui.actions.A_CmsWorkplaceAction

getDialogTitle, getDialogTitleKey, getTitle, getTitleKey, getVisibility, hasBlockingLocks, isActive, openDialog

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.ui.actions.I_CmsWorkplaceAction

getId

Constructor Detail

A_CmsEditFileAction

public A_CmsEditFileAction()

Method Detail

executeAction

public void executeAction(I_CmsDialogContext context)

Description copied from interface: I_CmsWorkplaceAction

Executes the action.

Specified by:

executeAction in interface I_CmsWorkplaceAction

Parameters:

context - the current dialog context.

See Also:

I_CmsWorkplaceAction.executeAction(org.opencms.ui.I_CmsDialogContext)

getCommandClassName

public java.lang.String getCommandClassName()

Description copied from interface: I_CmsADEAction

Returns the client side command to execute.

Specified by:

getCommandClassName in interface I_CmsADEAction

Returns:

the client side command

See Also:

I_CmsADEAction.getCommandClassName()

getJspPath

public java.lang.String getJspPath()

Description copied from interface: I_CmsADEAction

Returns the optional dialog JSP.

Specified by:

getJspPath in interface I_CmsADEAction

Returns:

the dialog JSP

See Also:

I_CmsADEAction.getJspPath()

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()

Description copied from interface: I_CmsADEAction

Returns the optional command parameters.

Specified by:

getParams in interface I_CmsADEAction

Returns:

the command parameters

See Also:

I_CmsADEAction.getParams()

getVisibility

public CmsMenuItemVisibilityMode getVisibility(CmsObject cms,
                                               java.util.List<CmsResource> resources)

Description copied from interface: I_CmsHasMenuItemVisibility

Gets the visibility for the current resource and CMS context.

Specified by:

getVisibility in interface I_CmsHasMenuItemVisibility

Parameters:

cms - the CMS context to use

resources - the list of resources to check

Returns:

the visibility

See Also:

I_CmsHasMenuItemVisibility.getVisibility(org.opencms.file.CmsObject, java.util.List)

isAdeSupported

public boolean isAdeSupported()

Description copied from interface: I_CmsADEAction

Returns whether the ADE context is supported.

Specified by:

isAdeSupported in interface I_CmsADEAction

Returns:

true in case the ADE context is supported

See Also:

I_CmsADEAction.isAdeSupported()

existsFile

protected boolean existsFile(I_CmsDialogContext context)

Checks whether the file specified by the file param and the given context exists and is visible.

Parameters:

context - the dialog context

Returns:

true in case the file exists and is visible

getFileParam

protected abstract java.lang.String getFileParam()

Returns the file parameter.

Returns:

parameter of the file to edit