Package org.opencms.ui.actions

Class CmsFavoriteDialogAction

java.lang.Object

org.opencms.ui.actions.A_CmsWorkplaceAction

org.opencms.ui.actions.CmsFavoriteDialogAction

All Implemented Interfaces:

I_CmsWorkplaceAction, I_CmsHasMenuItemVisibility

public class CmsFavoriteDialogAction
extends A_CmsWorkplaceAction

The action for the favorite dialog. This is only used for the favorite dialog opened from the page editor.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ACTION_ID	The action id.
static I_CmsHasMenuItemVisibility	VISIBILITY	The action visibility.

Constructor Summary

Constructors

Constructor	Description
CmsFavoriteDialogAction()

Method Summary

Modifier and Type	Method	Description
void	executeAction(I_CmsDialogContext context)	Executes the action.
java.lang.String	getId()	The action id.
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.

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

Field Detail

ACTION_ID

public static final java.lang.String ACTION_ID

The action id.

See Also:

Constant Field Values

VISIBILITY

public static final I_CmsHasMenuItemVisibility VISIBILITY

The action visibility.

Constructor Detail

CmsFavoriteDialogAction

public CmsFavoriteDialogAction()

Method Detail

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_CmsWorkplaceAction.executeAction(org.opencms.ui.I_CmsDialogContext)

getId

public java.lang.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,
                                               java.util.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)

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)

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