Package org.opencms.ui.actions
Class A_CmsWorkplaceAction
- java.lang.Object
-
- org.opencms.ui.actions.A_CmsWorkplaceAction
-
- All Implemented Interfaces:
I_CmsWorkplaceAction
,I_CmsHasMenuItemVisibility
- Direct Known Subclasses:
A_CmsEditFileAction
,A_CmsGalleryDialogAction
,A_CmsJSPAction
,A_CmsToolbarAction
,CmsAvailabilityDialogAction
,CmsCategoriesDialogAction
,CmsChangeTypeDialogAction
,CmsCopyDialogAction
,CmsCopyPageDialogAction
,CmsCopyToProjectDialogAction
,CmsDeleteDialogAction
,CmsDirectPublishDialogAction
,CmsDisplayAction
,CmsEditCodeDialogAction
,CmsEditDialogAction
,CmsEditPointerAction
,CmsEditPropertyAction
,CmsEditSmallElementsAction
,CmsEditUserDialogAction
,CmsFavoriteDialogAction
,CmsFormEditDialogAction
,CmsHistoryDialogAction
,CmsLinkLocaleVariantAction
,CmsLockAction
,CmsLockedResourcesAction
,CmsLogoutAction
,CmsMoveDialogAction
,CmsPermissionDialogAction
,CmsPrefillPageAction
,CmsPreviewAction
,CmsPropertiesDialogAction
,CmsPublishScheduledDialogAction
,CmsReindexDialogAction
,CmsRenameAction
,CmsReplaceDialogAction
,CmsResourceInfoAction
,CmsRestoreDeletedAction
,CmsSecureExportDialogAction
,CmsSelectElementViewAction
,CmsSeoAction
,CmsShowLocaleAction
,CmsSitemapAliasAction
,CmsSitemapAttributeEditorAction
,CmsSitemapEditConfigAction
,CmsSitemapOpenParentAction
,CmsSitemapRefreshAction
,CmsStealLockAction
,CmsTemplateContextsAction
,CmsTemplateMapperAction
,CmsTouchDialogAction
,CmsUndeleteDialogAction
,CmsUndoDialogAction
,CmsUnlinkLocaleVariantAction
,CmsUnlockAction
,CmsUnusedContentFinderAction
,CmsUserInfoDialogAction
,CmsViewInExplorerAction
,CmsViewOnlineAction
,CmsWorkplaceAction
public abstract class A_CmsWorkplaceAction extends java.lang.Object implements I_CmsWorkplaceAction
Abstract workplace actions class providing helper methods.
-
-
Constructor Summary
Constructors Constructor Description A_CmsWorkplaceAction()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDialogTitle()
Gets the title to use for the dialog.protected java.lang.String
getDialogTitleKey()
Returns the workplace message bundle key of the action dialog title.java.lang.String
getTitle(java.util.Locale locale)
Returns the localized action title.protected abstract java.lang.String
getTitleKey()
Returns the workplace message bundle key of the action title.CmsMenuItemVisibilityMode
getVisibility(I_CmsDialogContext context)
Gets the visibility for the current dialog context.protected boolean
hasBlockingLocks(I_CmsDialogContext context)
Returns if there are any blocking locks within the context resources.protected boolean
hasBlockingLocks(I_CmsDialogContext context, boolean showDialog)
Returns if there are any blocking locks within the context resources.boolean
isActive(I_CmsDialogContext context)
Checks whether this action should be active in the given dialog context.protected void
openDialog(CmsBasicDialog dialog, I_CmsDialogContext context)
Opens the given dialog in a new overlay window.protected void
openDialog(CmsBasicDialog dialog, I_CmsDialogContext context, CmsBasicDialog.DialogWidth dialogWidth)
Opens the given dialog in a new overlay window.-
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.contextmenu.I_CmsHasMenuItemVisibility
getVisibility
-
Methods inherited from interface org.opencms.ui.actions.I_CmsWorkplaceAction
executeAction, getId
-
-
-
-
Constructor Detail
-
A_CmsWorkplaceAction
public A_CmsWorkplaceAction()
-
-
Method Detail
-
getDialogTitle
public java.lang.String getDialogTitle()
Gets the title to use for the dialog.- Returns:
- the title to use for the dialog
-
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
- Parameters:
locale
- the user's workplace locale- Returns:
- the action title
- See Also:
I_CmsWorkplaceAction.getTitle(java.util.Locale)
-
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
- Parameters:
context
- the dialog context- Returns:
- the visibility
- See Also:
I_CmsHasMenuItemVisibility.getVisibility(org.opencms.ui.I_CmsDialogContext)
-
isActive
public boolean isActive(I_CmsDialogContext context)
Description copied from interface:I_CmsWorkplaceAction
Checks whether this action should be active in the given dialog context.- Specified by:
isActive
in interfaceI_CmsWorkplaceAction
- Parameters:
context
- the dialog context- Returns:
true
if this action should be active in the given dialog context- See Also:
I_CmsWorkplaceAction.isActive(org.opencms.ui.I_CmsDialogContext)
-
getDialogTitleKey
protected java.lang.String getDialogTitleKey()
Returns the workplace message bundle key of the action dialog title.- Returns:
- the dialog title message bundle key
-
getTitleKey
protected abstract java.lang.String getTitleKey()
Returns the workplace message bundle key of the action title.- Returns:
- the title message bundle key
-
hasBlockingLocks
protected boolean hasBlockingLocks(I_CmsDialogContext context)
Returns if there are any blocking locks within the context resources.Will open the blocking locks dialog if required.
- Parameters:
context
- the dialog context- Returns:
true
in case of blocking locks
-
hasBlockingLocks
protected boolean hasBlockingLocks(I_CmsDialogContext context, boolean showDialog)
Returns if there are any blocking locks within the context resources.Will open the blocking locks dialog if required.
- Parameters:
context
- the dialog contextshowDialog
- flag, indicating if the dialog should be displayed, hinting to the locked resources.- Returns:
true
in case of blocking locks
-
openDialog
protected void openDialog(CmsBasicDialog dialog, I_CmsDialogContext context)
Opens the given dialog in a new overlay window.- Parameters:
dialog
- the dialogcontext
- the dialog context
-
openDialog
protected void openDialog(CmsBasicDialog dialog, I_CmsDialogContext context, CmsBasicDialog.DialogWidth dialogWidth)
Opens the given dialog in a new overlay window.- Parameters:
dialog
- the dialogcontext
- the dialog contextdialogWidth
- The dialog width
-
-