Package org.opencms.ui.actions
Class CmsPrefillPageAction
- java.lang.Object
-
- org.opencms.ui.actions.A_CmsWorkplaceAction
-
- org.opencms.ui.actions.CmsPrefillPageAction
-
- All Implemented Interfaces:
I_CmsADEAction
,I_CmsWorkplaceAction
,I_CmsHasMenuItemVisibility
public class CmsPrefillPageAction extends A_CmsWorkplaceAction implements I_CmsADEAction
Action class for filling in container page content from a 'prefill template' configured via the sitemap configuration.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
GUI_EXPLORER_CONTEXT_PREFILL_PAGE_0
Message key for the context menu - this is not in a message bundle class because it is not defined by default.
-
Constructor Summary
Constructors Constructor Description CmsPrefillPageAction()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.java.lang.String
getTitle(java.util.Locale locale)
Returns the localized action title.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, hasBlockingLocks, hasBlockingLocks, isActive, openDialog, openDialog
-
-
-
-
Field Detail
-
GUI_EXPLORER_CONTEXT_PREFILL_PAGE_0
public static final java.lang.String GUI_EXPLORER_CONTEXT_PREFILL_PAGE_0
Message key for the context menu - this is not in a message bundle class because it is not defined by default.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsPrefillPageAction
public CmsPrefillPageAction()
-
-
Method Detail
-
executeAction
public void executeAction(I_CmsDialogContext context)
Description copied from interface:I_CmsWorkplaceAction
Executes the action.- Specified by:
executeAction
in interfaceI_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 interfaceI_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 interfaceI_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 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()
-
getTitle
public java.lang.String getTitle(java.util.Locale locale)
Description copied from interface:I_CmsWorkplaceAction
Returns the localized action title.- Specified by:
getTitle
in interfaceI_CmsWorkplaceAction
- Overrides:
getTitle
in classA_CmsWorkplaceAction
- Parameters:
locale
- the user's workplace locale- Returns:
- the action title
- See Also:
A_CmsWorkplaceAction.getTitle(java.util.Locale)
-
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
- 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.- Specified by:
getTitleKey
in classA_CmsWorkplaceAction
- Returns:
- the title message bundle key
- See Also:
A_CmsWorkplaceAction.getTitleKey()
-
-