Package org.opencms.ui.actions

Interface I_CmsWorkplaceAction

All Superinterfaces:

I_CmsHasMenuItemVisibility

All Known Subinterfaces:

I_CmsDefaultAction

All Known Implementing Classes:

A_CmsEditFileAction, A_CmsGalleryDialogAction, A_CmsJSPAction, A_CmsToolbarAction, A_CmsWorkplaceAction, CmsAboutDialogAction, CmsAvailabilityDialogAction, CmsCategoriesDialogAction, CmsChangeTypeDialogAction, CmsCopyDialogAction, CmsCopyPageDialogAction, CmsCopyToProjectDialogAction, CmsDataViewAction, CmsDeleteDialogAction, CmsDirectPublishDialogAction, CmsDisplayAction, CmsEditCodeDialogAction, CmsEditContentAction, CmsEditDialogAction, CmsEditPageAction, CmsEditPointerAction, CmsEditPropertyAction, CmsEditSmallElementsAction, CmsEditUserDialogAction, CmsFavoriteDialogAction, CmsFormEditDialogAction, CmsGalleryDialogAction, CmsGalleryOptimizeDialogAction, CmsHistoryDialogAction, CmsLinkLocaleVariantAction, CmsLockAction, CmsLockedResourcesAction, CmsLogoutAction, CmsMoveDialogAction, CmsPermissionDialogAction, CmsPreferencesDialogAction, CmsPrefillPageAction, CmsPreviewAction, CmsProjectDialogAction, CmsPropertiesDialogAction, CmsPublishQueueDialogAction, CmsPublishScheduledDialogAction, CmsReindexDialogAction, CmsRenameAction, CmsReplaceDialogAction, CmsResourceInfoAction, CmsRestoreDeletedAction, CmsSecureExportDialogAction, CmsSelectElementViewAction, CmsSeoAction, CmsShowLocaleAction, CmsSiteDialogAction, CmsSitemapAliasAction, CmsSitemapAttributeEditorAction, CmsSitemapEditConfigAction, CmsSitemapOpenParentAction, CmsSitemapRefreshAction, CmsStealLockAction, CmsTemplateContextsAction, CmsTemplateMapperAction, CmsTouchDialogAction, CmsUndeleteDialogAction, CmsUndoDialogAction, CmsUnlinkLocaleVariantAction, CmsUnlockAction, CmsUnusedContentFinderAction, CmsUserInfoDialogAction, CmsViewInExplorerAction, CmsViewOnlineAction, CmsWorkplaceAction

public interface I_CmsWorkplaceAction
extends I_CmsHasMenuItemVisibility

Workplace action interface.

Method Summary

Modifier and Type	Method	Description
void	executeAction(I_CmsDialogContext context)	Executes the action.
java.lang.String	getId()	The action id.
java.lang.String	getTitle(java.util.Locale locale)	Returns the localized action title.
boolean	isActive(I_CmsDialogContext context)	Checks whether this action should be active in the given dialog context.

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

getVisibility, getVisibility

Method Detail

executeAction

void executeAction(I_CmsDialogContext context)

Executes the action.

Parameters:

context - the current dialog context.

getId

java.lang.String getId()

The action id.

Returns:

the action id

getTitle

java.lang.String getTitle(java.util.Locale locale)

Returns the localized action title.

Parameters:

locale - the user's workplace locale

Returns:

the action title

isActive

boolean isActive(I_CmsDialogContext context)

Checks whether this action should be active in the given dialog context.

Parameters:

context - the dialog context

Returns:

true if this action should be active in the given dialog context