Package org.opencms.ui.actions

Class CmsLockAction

java.lang.Object

org.opencms.ui.actions.A_CmsWorkplaceAction

org.opencms.ui.actions.CmsLockAction

All Implemented Interfaces:

I_CmsWorkplaceAction, I_CmsHasMenuItemVisibility

public class CmsLockAction
extends A_CmsWorkplaceAction

Action to lock a folder if it isn't already locked, with a dialog asking to confirm your choice if the folder contains resources locked by other users.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_ID	The action id.

Constructor Summary

Constructors

Constructor	Description
CmsLockAction()

Method Summary

Modifier and Type	Method	Description
void	executeAction(I_CmsDialogContext context)	Executes the action.
String	getId()	The action id.
protected String	getTitleKey()	Returns the workplace message bundle key of the action title.
CmsMenuItemVisibilityMode	getVisibility(CmsObject cms, List<CmsResource> resources)	Gets the visibility for the current resource and CMS context.

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

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

Methods inherited from class java.lang.Object

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

Field Details

ACTION_ID

public static final String ACTION_ID

The action id.

See Also:

• Constant Field Values

Constructor Details

CmsLockAction

public CmsLockAction()

Method Details

executeAction

public void executeAction(I_CmsDialogContext context)

Description copied from interface: I_CmsWorkplaceAction

Executes the action.

Parameters:

context - the current dialog context.

See Also:

• I_CmsContextMenuAction.executeAction(org.opencms.ui.I_CmsDialogContext)

getId

public String getId()

Description copied from interface: I_CmsWorkplaceAction

The action id.

Returns:

the action id

See Also:

• I_CmsWorkplaceAction.getId()

getVisibility

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

Description copied from interface: I_CmsHasMenuItemVisibility

Gets the visibility for the current resource and CMS context.

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)

getTitleKey

protected String getTitleKey()

Description copied from class: A_CmsWorkplaceAction

Returns the workplace message bundle key of the action title.

Specified by:

getTitleKey in class A_CmsWorkplaceAction

Returns:

the title message bundle key

See Also:

• A_CmsWorkplaceAction.getTitleKey()