info.magnolia.ui.api.action
Interface ActionDefinition

All Known Subinterfaces:
MediaEditorFeatureDefinition
All Known Implementing Classes:
AbstractItemActionDefinition, ActivationActionDefinition, AddFolderActionDefinition, AddNodeActionDefinition, AddPropertyActionDefinition, CallbackDialogActionDefinition, CallbackFormActionDefinition, CancelDialogActionDefinition, CancelFormActionDefinition, ChooseDialogActionDefinition, CommandActionDefinition, ConfiguredActionDefinition, ConfiguredMediaEditorFeatureDefinition, ConfirmationActionDefinition, CreateAreaActionDefinition, CreateComponentActionDefinition, CreateItemActionDefinition, CropImageActionDefinition, DeactivationActionDefinition, DeleteActionDefinition, DeleteGroupActionDefinition, DeleteItemActionDefinition, DeleteMessageActionDefinition, DeleteRoleActionDefinition, DuplicateNodeActionDefinition, EditElementActionDefinition, EditItemActionDefinition, EditPageActionDefinition, ExportActionDefinition, FlipImageActionDefinition, GrayScaleActionDefinition, InternalMediaEditorActionDefinition, LogoutActionDefinition, MarkNodeAsDeletedActionDefinition, MediaEditorActionDefinition, MoveComponentActionDefinition, MoveNodeActionDefinition, OpenAddRoleDialogActionDefinition, OpenCreateDialogActionDefinition, OpenEditDialogActionDefinition, OpenEditRoleDialogActionDefinition, OpenMoveDialogActionDefinition, PreviewPageActionDefinition, PreviewPreviousVersionActionDefinition, RedoActionDefinition, RenameUsersFolderActionDefinition, RestorePreviousVersionActionDefinition, RestorePreviousVersionActionDefinition, RotateImageActionDefinition, SaveConfigDialogActionDefinition, SaveDialogActionDefinition, SaveFormActionDefinition, SaveGroupDialogActionDefinition, SaveImportDialogActionDefinition, SaveRoleDialogActionDefinition, SaveUserDialogActionDefinition, ScaleToActualSizeActionDefinition, ScaleToFitActionDefinition, ShowVersionsActionDefinition, SortComponentActionDefinition, UndoActionDefinition, ViewImageActionDefinition

public interface ActionDefinition

Action definitions are used to configure actions in many parts of the UI. The definition holds a name which is used to identify the action within a certain scope, for instance within a sub app. Many actions have dedicated action definition classes implementing this interface that allows supplying additional parameters to the action. Implementations are expected to provide correct Object.equals(Object) and Object.hashCode() methods.

See Also:
Action, ActionExecutor

Method Summary
 AvailabilityDefinition getAvailability()
           
 String getDescription()
           
 String getErrorMessage()
           
 String getFailureMessage()
           
 String getI18nBasename()
           
 String getIcon()
           
 Class<? extends Action> getImplementationClass()
           
 String getLabel()
           
 String getName()
           
 String getSuccessMessage()
           
 

Method Detail

getName

String getName()

getLabel

String getLabel()

getIcon

String getIcon()

getI18nBasename

String getI18nBasename()

getDescription

String getDescription()

getSuccessMessage

String getSuccessMessage()

getFailureMessage

String getFailureMessage()

getErrorMessage

String getErrorMessage()

getImplementationClass

Class<? extends Action> getImplementationClass()

getAvailability

AvailabilityDefinition getAvailability()


Copyright © 2013 Magnolia International Ltd.. All Rights Reserved.