org.opencms.ui.actions

Class CmsDisplayAction

java.lang.Object

org.opencms.ui.actions.A_CmsWorkplaceAction

org.opencms.ui.actions.CmsDisplayAction

All Implemented Interfaces:

I_CmsDefaultAction, I_CmsWorkplaceAction, I_CmsHasMenuItemVisibility

Direct Known Subclasses:

CmsEditPageAction

public class CmsDisplayAction
extends A_CmsWorkplaceAction
implements I_CmsDefaultAction

The display action. Renders the selected resource.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID The action id.
static java.lang.String	ONLINE_WINDOW_NAME The name of the online version window.
static I_CmsHasMenuItemVisibility	VISIBILITY The action visibility.

Constructor Summary

Constructors

Constructor and Description
CmsDisplayAction()

Method Summary

Modifier and Type	Method and Description
void	executeAction(I_CmsDialogContext context) Executes the action.
int	getDefaultActionRank(I_CmsDialogContext context) Returns the action rank, the highest ranked default action will be used.
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.

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

getDialogTitle, getDialogTitleKey, getTitle, 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

getTitle, isActive

Methods inherited from interface org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility

getVisibility

Field Detail

ONLINE_WINDOW_NAME

public static final java.lang.String ONLINE_WINDOW_NAME

The name of the online version window.

See Also:

Constant Field Values

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

CmsDisplayAction

public CmsDisplayAction()

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)

getDefaultActionRank

public int getDefaultActionRank(I_CmsDialogContext context)

Description copied from interface: I_CmsDefaultAction

Returns the action rank, the highest ranked default action will be used.

Specified by:

getDefaultActionRank in interface I_CmsDefaultAction

Parameters:

context - the dialog context

Returns:

the action rank

See Also:

I_CmsDefaultAction.getDefaultActionRank(org.opencms.ui.I_CmsDialogContext)

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

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)

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