Package org.opencms.ui.actions

Class CmsTemplateContextsAction

java.lang.Object

org.opencms.ui.actions.A_CmsWorkplaceAction

org.opencms.ui.actions.CmsTemplateContextsAction

All Implemented Interfaces:

I_CmsADEAction, I_CmsWorkplaceAction, I_CmsHasMenuItemVisibility

public class CmsTemplateContextsAction
extends A_CmsWorkplaceAction
implements I_CmsADEAction

Template context selection action.

This is handled specially by the client side code.

Constructor Summary

Constructors

Constructor	Description
CmsTemplateContextsAction(int menuPosition)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	executeAction(I_CmsDialogContext context)	Executes the action.
java.lang.String	getCommandClassName()	Returns the client side command to execute.
java.lang.String	getId()	The action id.
java.lang.String	getJspPath()	Returns the optional dialog JSP.
java.util.Map<java.lang.String,java.lang.String>	getParams()	Returns the optional command parameters.
protected java.lang.String	getTitleKey()	Returns the workplace message bundle key of the action title.
CmsMenuItemVisibilityMode	getVisibility(CmsObject cms, java.util.List<CmsResource> resources)	Gets the visibility for the current resource and CMS context.
CmsMenuItemVisibilityMode	getVisibility(I_CmsDialogContext context)	Gets the visibility for the current dialog context.
boolean	isAdeSupported()	Returns whether the ADE context is supported.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsTemplateContextsAction

public CmsTemplateContextsAction(int menuPosition)

Creates a new instance.

Parameters:

menuPosition - the position in the context menu

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()

getId

public java.lang.String getId()

Description copied from interface: I_CmsWorkplaceAction

The action id.

Specified by:

getId in interface I_CmsWorkplaceAction

Returns:

the action id

See Also:

I_CmsWorkplaceAction.getId()

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)

getVisibility

public CmsMenuItemVisibilityMode getVisibility(I_CmsDialogContext context)

Description copied from interface: I_CmsHasMenuItemVisibility

Gets the visibility for the current dialog context.

Specified by:

getVisibility in interface I_CmsHasMenuItemVisibility

Overrides:

getVisibility in class A_CmsWorkplaceAction

Parameters:

context - the dialog context

Returns:

the visibility

See Also:

A_CmsWorkplaceAction.getVisibility(org.opencms.ui.I_CmsDialogContext)

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()

getTitleKey

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