Package org.opencms.ui.actions
Class CmsEditPageAction
- java.lang.Object
-
- org.opencms.ui.actions.A_CmsWorkplaceAction
-
- org.opencms.ui.actions.CmsDisplayAction
-
- org.opencms.ui.actions.CmsEditPageAction
-
- All Implemented Interfaces:
I_CmsADEAction
,I_CmsDefaultAction
,I_CmsWorkplaceAction
,I_CmsHasMenuItemVisibility
public class CmsEditPageAction extends CmsDisplayAction implements I_CmsADEAction
The edit page action. Available for container pages.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ACTION_ID
The action id.-
Fields inherited from class org.opencms.ui.actions.CmsDisplayAction
ONLINE_WINDOW_NAME, VISIBILITY
-
-
Constructor Summary
Constructors Constructor Description CmsEditPageAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCommandClassName()
Returns the client side command to execute.int
getDefaultActionRank(I_CmsDialogContext context)
Returns the action rank, the highest ranked default action will be used.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.CmsDisplayAction
executeAction
-
Methods inherited from class org.opencms.ui.actions.A_CmsWorkplaceAction
getDialogTitle, getDialogTitleKey, getTitle, hasBlockingLocks, isActive, openDialog, 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
-
-
-
-
Field Detail
-
ACTION_ID
public static final java.lang.String ACTION_ID
The action id.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsEditPageAction
public CmsEditPageAction()
-
-
Method Detail
-
getCommandClassName
public java.lang.String getCommandClassName()
Description copied from interface:I_CmsADEAction
Returns the client side command to execute.- Specified by:
getCommandClassName
in interfaceI_CmsADEAction
- Returns:
- the client side command
- See Also:
I_CmsADEAction.getCommandClassName()
-
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 interfaceI_CmsDefaultAction
- Overrides:
getDefaultActionRank
in classCmsDisplayAction
- 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 interfaceI_CmsWorkplaceAction
- Overrides:
getId
in classCmsDisplayAction
- 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 interfaceI_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 interfaceI_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 interfaceI_CmsHasMenuItemVisibility
- Overrides:
getVisibility
in classCmsDisplayAction
- Parameters:
cms
- the CMS context to useresources
- 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 interfaceI_CmsHasMenuItemVisibility
- Overrides:
getVisibility
in classA_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 interfaceI_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.- Overrides:
getTitleKey
in classCmsDisplayAction
- Returns:
- the title message bundle key
- See Also:
A_CmsWorkplaceAction.getTitleKey()
-
-